Commits

Anonymous committed 779a0c2 Draft Merge

Merge with default

  • Participants
  • Parent commits 24bd8b3, b8b4573
  • Branches 1.0.6

Comments (0)

Files changed (3)

File LICENSE_EN.txt

+Copyright (c) 2011-2012, Eugene Veretennikov
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+    * Redistributions of source code must retain the above copyright
+      notice, this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright
+      notice, this list of conditions and the following disclaimer in the
+      documentation and/or other materials provided with the distribution.
+    * Neither the name of the <organization> nor the
+      names of its contributors may be used to endorse or promote products
+      derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL <COPYRIGHT HOLDER> BE LIABLE FOR ANY
+DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

File LICENSE_RU.txt

+Copyright (c) 2011-2012, Eugene Veretennikov
+
+Разрешается повторное распространение и использование как в виде исходного кода, 
+так и в двоичной форме, с изменениями или без, при соблюдении следующих условий:
+    * При повторном распространении исходного кода должно оставаться указанное 
+      выше уведомление об авторском праве, этот список условий и 
+      последующий отказ от гарантий.
+    * При повторном распространении двоичного кода должна сохраняться указанная 
+      выше информация об авторском праве, этот список условий и последующий 
+      отказ от гарантий в документации и/или в других материалах, поставляемых 
+      при распространении.
+    * Ни название <Организации>, ни имена ее сотрудников не могут быть 
+      использованы в качестве поддержки или продвижения продуктов, основанных 
+      на этом ПО без предварительного письменного разрешения.
+
+ЭТА ПРОГРАММА ПРЕДОСТАВЛЕНА ВЛАДЕЛЬЦАМИ АВТОРСКИХ ПРАВ И/ИЛИ ДРУГИМИ СТОРОНАМИ 
+«КАК ОНА ЕСТЬ» БЕЗ КАКОГО-ЛИБО ВИДА ГАРАНТИЙ, ВЫРАЖЕННЫХ ЯВНО ИЛИ ПОДРАЗУМЕВАЕМЫХ, 
+ВКЛЮЧАЯ, НО НЕ ОГРАНИЧИВАЯСЬ ИМИ, ПОДРАЗУМЕВАЕМЫЕ ГАРАНТИИ КОММЕРЧЕСКОЙ ЦЕННОСТИ И 
+ПРИГОДНОСТИ ДЛЯ КОНКРЕТНОЙ ЦЕЛИ. НИ В КОЕМ СЛУЧАЕ, ЕСЛИ НЕ ТРЕБУЕТСЯ СООТВЕТСТВУЮЩИМ 
+ЗАКОНОМ, ИЛИ НЕ УСТАНОВЛЕНО В УСТНОЙ ФОРМЕ, НИ ОДИН ВЛАДЕЛЕЦ АВТОРСКИХ ПРАВ И НИ 
+ОДНО ДРУГОЕ ЛИЦО, КОТОРОЕ МОЖЕТ ИЗМЕНЯТЬ И/ИЛИ ПОВТОРНО РАСПРОСТРАНЯТЬ ПРОГРАММУ, 
+КАК БЫЛО СКАЗАНО ВЫШЕ, НЕ НЕСЁТ ОТВЕТСТВЕННОСТИ, ВКЛЮЧАЯ ЛЮБЫЕ ОБЩИЕ, СЛУЧАЙНЫЕ, 
+СПЕЦИАЛЬНЫЕ ИЛИ ПОСЛЕДОВАВШИЕ УБЫТКИ, ВСЛЕДСТВИЕ ИСПОЛЬЗОВАНИЯ ИЛИ НЕВОЗМОЖНОСТИ 
+ИСПОЛЬЗОВАНИЯ ПРОГРАММЫ (ВКЛЮЧАЯ, НО НЕ ОГРАНИЧИВАЯСЬ ПОТЕРЕЙ ДАННЫХ, ИЛИ ДАННЫМИ, 
+СТАВШИМИ НЕПРАВИЛЬНЫМИ, ИЛИ ПОТЕРЯМИ ПРИНЕСЕННЫМИ ИЗ-ЗА ВАС ИЛИ ТРЕТЬИХ ЛИЦ, ИЛИ 
+ОТКАЗОМ ПРОГРАММЫ РАБОТАТЬ СОВМЕСТНО С ДРУГИМИ ПРОГРАММАМИ), ДАЖЕ ЕСЛИ ТАКОЙ 
+ВЛАДЕЛЕЦ ИЛИ ДРУГОЕ ЛИЦО БЫЛИ ИЗВЕЩЕНЫ О ВОЗМОЖНОСТИ ТАКИХ УБЫТКОВ.
-ActionScript 3 Social Network API - универсальная прослойка для работы с API различных соцсетей из Flash-приложений. 
+ActionScript 3 Social Network API - универсальная библиотека для работы с API соцсетей из Flash-приложений. 
 
-Библиотека as3snapi основана на опыте работы с API популяных соцсетей наработанном в Igrostar (http://igrostar.com)
+
+ЛИЦЕНЗИЯ 
+
+BSD 
+
+
+ОСНОВНЫЕ ВОЗМОЖНОСТИ
+
+На данный момент реализованы базовые функции API: 
+* получение друзей; 
+* получение друзей в приложении; 
+* получение своего профиля; 
+* отображение окна приглашения друзей. 
+Из документации имеется код приложения sandbox (в репозитории) :)
+
+Список поддерживаемых соцсетей: 
+* http://vk.com - Вконтакте;
+* http://my.mail.ru - Мой мир;
+* http://odnoklassniki.ru - Одноклассники;
+* http://facebook.com - Facebook (черновая реализация);
+* mock - тестовая offline-сеть на основе конфиг-файла. Имеется возможность сделать сделать снимок данных с любой из вышеперечисленных сетей и использовать их оффлайн для отладки через mock сеть.
+В ближайших планах расширение этого списка.
+ 
+
+ОСОБЕНОСТИ
 
 Основные идеи заложенные в as3snapi:
-* можно использвать общий swf файл приложения для всех соцсетей;
-* приложение без изменений можно использовать и в собственном iframe и заливая на сервера соцсетей (my.mail.ru vk.com)
-* доступная соцсеть определяется автоматически на основе flashvars;
-* подключение новых сетей не должно требовать серьезных изменений кода приложения;
-* в приложение включается код только для используемых сетей;
-* максимальное повторное использование кода внутри библиотеки;
-* большинство сетей предоставлюят схожий API, для них библиотека предоставляет общий интерфейс;
-* в экзотических соцсетях любая привычная функция может отсутствовать (нет окна приглашения друзей, нет функции загрузки всех друзей, нет функции загрузки профиля по id и т.д.), код приложения должен быть готов к этому и иметь возможность проверить доступность функционала.
+* использовать единый swf файл приложения для всех соцсетей;
+* предоставлять возможность запуска приложения без изменений через iframe и непосредсвенно swf (my.mail.ru, vk.com)
+* определять доступную соцсеть автоматически, на основе flashvars;
+* включать в приложение код только для используемых сетей;
+* максимально повторно использовать код внутри библиотеки;
+* предоставлять общий интерфейс для схожего API разлиных сетей;
+* оставлять возможность прямого доступа к специфичным функциям соцсети;
+* предоставлять возможность работы в offline-режиме (mock-сеть);
+* быть "готовой ко всему". В экзотических соцсетях любая привычная функция может отсутствовать (нет окна приглашения друзей, нет функции загрузки всех друзей, нет функции загрузки профиля по id и т.д.), код приложения должен быть готов к этому и иметь возможность проверить доступность функционала.
 
 Особенности реализации:
 * Доступ к возможностям соцсетей осуществялется через механизм 'фич' (обычный ActionScript interface) подключаемых к общей 'шине' (примитивный IoC-контейнер);
 * Для доступа к специфичным возможностям модуль соцсети вводит свои собственные дополнительные 'фичи'; 
 * Модули сетей реализованы в виде отдельных плагинов. 
 
-Текущая реализация поддерживает: 
-* http://vk.com - Вконтакте;
-* http://my.mail.ru - Мой мир;
-* http://odnoklassniki.ru -Одноклассники ;
-* mock - тестовая offline сеть на основе конфиг-файла. Имеется возможность сделать сделать сномок данных с любой из вышеперечисленных сетей и использовать их оффлайн для отладки через mock сеть.
-В ближайших планах расширение этого списка.
 
-На данный момент сети поддерживают только базовые функции: 
-* получение друзей; 
-* получение друзей в приложении; 
-* получение своего профиля; 
-* отображение окна приглашения друзей. 
-На данный момент из документации имеется только код приложения sandbox (в репозитории) :)
+ПРИМЕРЫ ИСПОЛЬЗОВАНИЯ
 
 Собраную песочницу можно скачать отсюда:
 https://bitbucket.org/nitrobin/as3snapi/downloads
 http://cdn.bitbucket.org/nitrobin/as3snapi/downloads/as3snapi-sandbox-1.0.4-SNAPSHOT.swf
 Без параметров приложение запуститься в режиме mock;
 
-Библиотека находится в стадии активной разработки и API может быть изменен.
-
-Пример использования (инициализация API и загрузка своего профиля):
+Пример на ActionScript3 инициализации API и загрузки своего профиля:
 
 // as3snapi-sandbox/src/HelloWorld.as
 public class HelloWorld extends Sprite {
         appFriendsUids:[2],
         friendsUids:[2, 3]
     };
-}
+}
+
+
+ГДЕ ИСПОЛЬЗУЕТСЯ?
+
+Изначально библиотека разработана с прицелом на использование в домашних экспериментальных проектах, но нашла применение и за их пределами. :) 
+В настоящее время используется в проекте "Мастера войны" (http://vk.com/app2699907) компании "Igrostar" (http://igrostar.com)
+
+
+АВТОР
+2012 (c) Евгений Веретенников ["nitro.bin","gmail.com"].join("@")
+