to_net_me_api 0.1.beta → 0.2

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+## 0.2 (26.09.2013) 
+
+* Добавлен модуль конфигурации
+
+## 0.1 (24.09.2013) 
+
+* первая стабильная версия

data/README.md

@@ -1,4 +1,69 @@
-to_net_me_api
-=============
-
-ruby-адаптер для api.2net.me
+## to_net_me_api [![Gem Version](https://badge.fury.io/rb/to_net_me_api.png)](http://badge.fury.io/rb/to_net_me_api)
+
+
+
+
+
+`to_net_me_api` - ruby-адаптер для api.2net.me. Он позволяет вызывать методы API.
+
+
+
+## Установка
+
+
+
+``` ruby
+
+# Gemfile
+
+gem 'to_net_me_api'
+
+```
+
+
+
+или просто
+
+
+
+``` sh
+
+$ gem install to_net_me_api
+
+```
+
+
+
+## Использование
+
+
+
+### Вызов методов
+
+
+
+``` ruby
+require 'to_net_me_api' #=> true
+
+# создаем клиент
+@to_net_me = ToNetMeApi::Client.new('auth_key')
+# и вызываем методы API
+groups = @to_net_me.search.groups(:name=>'велосипеды',:vk=>'true')
+
+# методы возвращают объект HTTParty 
+# в котором находится ответ от сервека api.2net.me
+groups.parsed_response #=> {"message"=>{"vk"=>[7389, {"gid"=>52734067, "name"=>"Велосипеды"....
+
+# в ruby принято использовать snake_case в названиях методов,
+# поэтому search.groupsById становится search.groups_by_id
+@to_net_me.search.groups_by_id(:gids=>'37856556',:soc=>'vk')
+
+# если API 2net.me ожидает получить параметр в виде списка,
+# разделенного запятыми, то его можно передать массивом
+@to_net_me.search.groups_by_id(:gids=>'2net_me,37856556,38019449',:soc=>'vk')
+```
+### Документация
+
+Документация к методам api находится [по адресу](http://api.2net.me/index/info).
+Так же можно попробовать api через web-интерфейс [тут](http://api.2net.me/index).
+

data/lib/to_net_me_api.rb

@@ -0,0 +1,32 @@
+require 'httparty'
+require 'yaml'
+require 'hashie'
+
+require 'to_net_me_api/version'
+require 'to_net_me_api/configuration'
+require 'to_net_me_api/api'
+require 'to_net_me_api/resolver'
+require 'to_net_me_api/resolvable'
+require 'to_net_me_api/client'
+require 'to_net_me_api/namespace'
+require 'to_net_me_api/method'
+
+
+# Main module.
+module ToNetMeApi
+  extend ToNetMeApi::Configuration
+  #extend VkontakteApi::Authorization
+  #extend VkontakteApi::Uploading
+  
+  class << self
+    # Creates a short alias `TNM` for `ToNetMeApi` module.
+    def register_alias
+      Object.const_set(:TNM, ToNetMeApi)
+    end
+    
+    # Removes the `TNM` alias.
+    def unregister_alias
+      Object.send(:remove_const, :TNM) if defined?(TNM)
+    end
+  end
+end

data/lib/to_net_me_api/api.rb

@@ -0,0 +1,18 @@
+# require 'httparty'
+module ToNetMeApi
+  # Модуль обрабатывает запросы к API 2et.me и возвращает HTTParty объект .
+  module API
+      
+    class << self
+ 	  
+			def call(attrs,options={},auth_key = nil)
+				@auth = {:auth_key => auth_key}				
+			  options.merge!(@auth)
+			  HTTParty.get('http://api.2net.me/'+attrs,:query => options)
+			end
+			
+    end
+  end
+
+end
+

data/lib/to_net_me_api/client.rb

@@ -0,0 +1,81 @@
+# require '~/rubystack/projects/users_part/lib/to_net_me_api/namespace'
+# require '~/rubystack/projects/users_part/lib/to_net_me_api/resolvable'
+# require '~/rubystack/projects/users_part/lib/to_net_me_api/resolver'
+# require '~/rubystack/projects/users_part/lib/to_net_me_api/method'
+module ToNetMeApi
+  # Класс, представляющий соединение с api.2net.me. 
+  class Client
+    include Resolver
+    
+    # Права доступа и их числовые значения.
+    SCOPE = {
+      root:                 0,
+      admin:                1,
+      partner:              2,
+      user:   		          3,
+      unknown_auth_key:     4, 
+
+    }
+    
+    # ключ доступа к методам api
+    # @return [String]
+    attr_reader :auth_key
+    # Current user id.
+    # @return [Integer]
+    attr_reader :user_id
+    # время жизни auth_key
+    # @return [Time]
+    attr_reader :expires_at
+    
+    # API client.
+    # определяем переменные 
+    def initialize(auth_key = nil)
+      if auth_key.respond_to?(:auth_key) && auth_key.respond_to?(:params)
+        # auth_key is an OAuth2::Accessauth_key
+        @auth_key      = auth_key.auth_key
+        @user_id    = auth_key.params['user_id']
+        @expires_at = Time.at(auth_key.expires_at) unless auth_key.expires_at.nil?
+      else
+        # если auth_key нет или пришла строка (string)
+        @auth_key = auth_key
+      end
+    end
+    
+    # Авторизирован пользователь.
+    def authorized?
+      !@auth_key.nil?
+    end
+    
+     # Просрочет ключь или нет.
+    def expired?
+      @expires_at && @expires_at < Time.now
+    end
+    
+    
+    # Права доступа для auth_key.
+    # @return Symbol  
+    def scope
+
+      SCOPE.reject do |access_scope, mask|	
+      	return SCOPE.invert[settings]
+      end
+
+    end
+    
+    # Если вызываемы метод содержется в namespace, создается новый  `VkontakteApi::Namespace` инстанс.
+    # `VkontakteApi::Namespace` так же выхывает method_missing для метода объекта Namespace
+    # если нет namspace `VkontakteApi::Method` создаеся объект API в который передаются параметры.
+    def method_missing(*args, &block)
+      if Namespace.exists?(args.first)
+        create_namespace(args.first)
+      else
+        call_method(args, &block)
+      end
+    end
+    
+  private
+    def settings
+      @settings ||= @auth_key[0].gsub(/[^0-9]/,'4').to_i
+    end
+  end
+end

data/lib/to_net_me_api/configuration.rb

@@ -0,0 +1,29 @@
+module ToNetMeApi
+	# Генерация модуля конфигураци 
+	#
+	# ToNetMeApi::Configuration 
+	module Configuration
+		#доступные опции для конфигурации
+    OPTION_NAMES = [
+      :api_core,
+    ]
+
+    attr_accessor *OPTION_NAMES
+
+    # адрес api по умолчанию
+    DAFAULT_API_ADDRESS = 'http://api.2net.me/'
+
+    # Можно задавать конфигурацию для гема так:
+    # ToNetMeApi.configure {|config| config.api_core='http://sandbox.api.2net.me/'}
+
+    def  configure
+    	yield self if block_given?
+    	self
+    end
+
+    #установка всех конфигураций в дефолтное значение
+    def reset
+    	@api_core = DAFAULT_API_ADDRESS
+    end
+	end
+end

data/lib/to_net_me_api/error.rb

@@ -0,0 +1,54 @@
+module ToNetMeApi
+  # An exception raised by `ToNetMeApi::Result` when given a response with an error.
+  class Error < StandardError
+    # An error code.
+    # @return [Fixnum]
+    attr_reader :error_code
+    # Captcha identifier (only for "Captcha needed" errors).
+    # @return [String]
+    attr_reader :captcha_sid
+    # Captcha image URL (only for "Captcha needed" errors).
+    # @return [String]
+    attr_reader :captcha_img
+    
+    # An exception is initialized by the data from response mash.
+    # @param [Hash] data Error data.
+    def initialize(data)
+      @error_code = data.error_code
+      @error_msg  = data.error_msg
+      
+      request_params = parse_params(data.request_params)
+      
+      @method_name  = request_params.delete('method')
+      @access_token = request_params.delete('access_token')
+      @oauth        = request_params.delete('oauth')
+      @params       = request_params
+      
+      @captcha_sid  = data.captcha_sid
+      @captcha_img  = data.captcha_img
+    end
+    
+    # A full description of the error.
+    # @return [String]
+    def message
+      message = "VKontakte returned an error #{@error_code}: '#{@error_msg}'"
+      message << " after calling method '#{@method_name}'"
+      
+      if @params.empty?
+        message << " without parameters."
+      else
+        message << " with parameters #{@params.inspect}."
+      end
+      
+      message
+    end
+    
+  private
+    def parse_params(params)
+      params.inject({}) do |memo, pair|
+        memo[pair[:key]] = pair[:value]
+        memo
+      end
+    end
+  end
+end

data/lib/to_net_me_api/method.rb

@@ -0,0 +1,45 @@
+# require '~/rubystack/projects/users_part/lib/to_net_me_api/api'
+# require '~/rubystack/projects/users_part/lib/to_net_me_api/result'
+module ToNetMeApi
+  # An API method. It is responsible for generating it's full name and determining it's type.
+  class Method
+    include Resolvable
+    
+    # A pattern for names of methods with a boolean result.
+    PREDICATE_NAMES = /^is.*\?$/
+    
+    # Calling the API method.
+    # It delegates the network request to `API.call` and result processing to `Result.process`.
+    # @param [Hash] args Arguments for the API method.
+    def call(args = {}, &block)
+      # raise full_name.inspect
+      response = API.call(full_name, args, auth_key)
+      # raise type.inspect
+      # когда ответ бует стандартизирован тогда нужно будет делать вывод результата иобработку ошибок
+      # Result.process(response, type, block)
+    end
+    
+  private
+    def full_name
+      parts = [@previous_resolver.name, @name].compact.map { |part| camelize(part) }
+      parts.join(' ').gsub(/[^A-Za-z.]/, '/')
+    end
+    
+    def type
+      @name =~ PREDICATE_NAMES ? :boolean : :anything
+    end
+    
+    # camelize('get_profiles')
+    # => 'getProfiles'
+    def camelize(name)
+      words = name.split('_')
+      first_word = words.shift
+      
+      words.each do |word|
+        word.sub!(/^[a-z]/, &:upcase)
+      end
+      
+      words.unshift(first_word).join
+    end
+  end
+end

data/lib/to_net_me_api/namespace.rb

@@ -0,0 +1,43 @@
+require '~/rubystack/projects/users_part/lib/to_net_me_api/resolvable'
+require '~/rubystack/projects/users_part/lib/to_net_me_api/resolver'
+require 'yaml'
+
+module ToNetMeApi
+  # API метод namespace (такие как `users` или `search`).
+  # 
+  # Включает в себя два модуля `Resolvable` и `Resolver` 
+  # которые вызывают методы api с помощью `Resolver#call_method`.
+  # также класс содержит список всех объектов api.2net.me.
+  class Namespace
+    include Resolvable
+    include Resolver
+    
+    # создает и вызывает `ToNetMeApi::Method` используя `ToNetMeApi::Resolver#call_method`.
+    def method_missing(*args, &block)
+    	
+      call_method(args, &block)
+
+    end
+    
+    class << self
+      # Массив всех объектов api.2net.me.
+      # 
+      # Загрузка файла `namespaces.yml` .
+      # @return [Array] An array of strings
+      def names
+        if @names.nil?
+          filename = File.expand_path('../namespaces.yml', __FILE__)
+          @names   = YAML.load_file(filename)
+        end
+        
+        @names
+      end
+      
+      # Проверяет есть ли такой объект у api.2net.me?
+      # @param [String, Symbol] name
+      def exists?(name)
+        names.include?(name.to_s)
+      end
+    end
+  end
+end

data/lib/to_net_me_api/namespaces.yml

@@ -0,0 +1,7 @@
+- audios
+- groups
+- posts
+- search
+- users
+- index
+- help

data/lib/to_net_me_api/resolvable.rb

@@ -0,0 +1,20 @@
+module ToNetMeApi
+
+  module Resolvable
+    attr_reader :name
+    
+    # инициализация объекта и метода api.2net.me
+    # @param [String] name The name of this resolvable.
+    # @option options [Hashie::Mash] :resolver A mash holding information about the previous resolver.
+    def initialize(name, options = {})
+      @name = name.to_s
+      @previous_resolver = options.delete(:resolver)
+    end
+    
+    # Returns the auth_key from the previous resolver.
+    # @return [String] A auth_key.
+    def auth_key
+      @previous_resolver.auth_key
+    end
+  end
+end

data/lib/to_net_me_api/resolver.rb

@@ -0,0 +1,34 @@
+# require 'hashie'
+module ToNetMeApi
+  # A mixin for classes that will resolve other classes' objects via `#method_missing`.
+  module Resolver
+    # A `Hashie::Mash` structure holding the name and auth_key of current instance.
+    # @return [Hashie::Mash]
+    def resolver
+      @resolver ||= Hashie::Mash.new(name: @name, auth_key: auth_key)
+    end
+    
+  private
+    def create_namespace(name)
+      Namespace.new(name, resolver: resolver)
+    end
+    
+    def create_method(name)
+      Method.new(name, resolver: resolver)
+    end
+    
+    def call_method(args, &block)
+      create_method(args.shift).call(args.first || {}, &block)
+    end
+    
+    # class << self
+    #   # When this module is included, it undefines the `:send` instance method in the `base_class`
+    #   # so it can be resolved via `method_missing`.
+    #   def included(base_class)
+    #     base_class.class_eval do
+    #       undef_method :send
+    #     end
+    #   end
+    # end
+  end
+end

data/lib/to_net_me_api/result.rb

@@ -0,0 +1,49 @@
+module ToNetMeApi
+  # A module that handles method result processing.
+  # 
+  # It implements method blocks support, result typecasting and raises `ToNetMeApi::Error` in case of an error response.
+  module Result
+    class << self
+      # The main method result processing.
+      # @param [Hashie::Mash] response The server response in mash format.
+      # @param [Symbol] type The expected result type (`:boolean` or `:anything`).
+      # @param [Proc] block A block passed to the API method.
+      # @return [Array, Hashie::Mash] The processed result.
+      # @raise [ToNetMeApi::Error] raised when VKontakte returns an error response.
+      def process(response, type, block)
+        raise response['error_code'].inspect
+        result = extract_result(response)
+        
+        if result.respond_to?(:each)
+          # enumerable result receives :map with a block when called with a block
+          # or is returned untouched otherwise
+          block.nil? ? result : result.map(&block)
+        else
+          # non-enumerable result is typecasted
+          # (and yielded if block_given?)
+          result = typecast(result, type)
+          block.nil? ? result : block.call(result)
+        end
+      end
+      
+    private
+      def extract_result(response)
+        if response.error?
+          raise ToNetMeApi::Error.new(response.error)
+        else
+          response.response
+        end
+      end
+      
+      def typecast(parameter, type)
+        case type
+        when :boolean
+          # '1' becomes true, '0' becomes false
+          !parameter.to_i.zero?
+        else
+          parameter
+        end
+      end
+    end
+  end
+end

data/lib/to_net_me_api/version.rb

@@ -0,0 +1,4 @@
+module ToNetMeApi
+  # Library version.
+  VERSION = '0.2'
+end

data/to_net_me_api.gemspec

@@ -0,0 +1,25 @@
+# encoding: utf-8
+$: << File.expand_path('../lib', __FILE__)
+require 'to_net_me_api/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'to_net_me_api'
+  s.version     = ToNetMeApi::VERSION
+  s.authors     = ['Sergey Chechaev']
+  s.email       = ['sergey@2net.me']
+  s.homepage    = 'https://github.com/sergey-chechaev/to_net_me_api'
+  s.summary     = %q{Ruby wrapper for api.2net.me}
+  s.description = %q{A transparent wrapper for 2net.me API. Supports ruby-way naming of API methods (without method lists inside) with api request by HTTParty.}
+  s.license     = ''
+  
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  s.require_paths = ['lib']
+  
+  s.required_ruby_version = '>= 1.9.3'
+  
+  s.add_runtime_dependency 'httparty',                     '~> 0.11'
+  s.add_runtime_dependency 'hashie',                       '~> 2.0'
+  
+end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: to_net_me_api
 version: !ruby/object:Gem::Version
-  version: 0.1.beta
-  prerelease: 4
+  version: '0.2'
+  prerelease: 
 platform: ruby
 authors:
 - Sergey Chechaev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-25 00:00:00.000000000 Z
+date: 2013-09-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -52,7 +52,21 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- CHANGELOG.md
 - README.md
+- lib/to_net_me_api.rb
+- lib/to_net_me_api/api.rb
+- lib/to_net_me_api/client.rb
+- lib/to_net_me_api/configuration.rb
+- lib/to_net_me_api/error.rb
+- lib/to_net_me_api/method.rb
+- lib/to_net_me_api/namespace.rb
+- lib/to_net_me_api/namespaces.yml
+- lib/to_net_me_api/resolvable.rb
+- lib/to_net_me_api/resolver.rb
+- lib/to_net_me_api/result.rb
+- lib/to_net_me_api/version.rb
+- to_net_me_api.gemspec
 homepage: https://github.com/sergey-chechaev/to_net_me_api
 licenses:
 - ''
@@ -69,9 +83,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>'
+  - - ! '>='
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24