bungie_client 0.6.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9f0b5c103d49481ce7300bd2724679f860977880
-  data.tar.gz: 998c54fc103ba3ccec2473bb9e6e53f747293781
+  metadata.gz: dbcc8ccd4f843c09b035c1cadf0d3104cc2cb6c2
+  data.tar.gz: d3e03ebaae92ef497c8388b02f3a1239d7501965
 SHA512:
-  metadata.gz: 9f3f1ef5947d8e36f9109d7c9aa86a2bae01ffa84b2432e16c64f063b4821b246fa8cefe97a09495f25a0f81ddce9b74854b222b0bb95ae1c93778263a10f6aa
-  data.tar.gz: 270f89f6c368a7dc9f756329fc8ba3f6d7dde138d2036e5cedabf65bc53851bb343d6f1c9bb40b93bf52f49c2c7f21da65c712431a0981420bd8cc5e00de827a
+  metadata.gz: 125fcbc0d2023e58cf1c189d88a0ea4ba781696d138f495dd3464d2d9ed2f554f18470d1be1ec156c092abea888c1b0ef0a412231d4cd98db244618ba1231a12
+  data.tar.gz: 58abe874906be78e8859167be290386b048ecd8632935b6123e9dc30562e0672b4f622ddde7a538821abc76808337d5840e2550b8f8d02a6a0294b9fb0b2aebb

data/.gitignore

@@ -7,5 +7,8 @@
 /pkg/
 /spec/reports/
 /tmp/
+.rspec
+.travis.yml
 .idea
 *.gem
+Gemfile.lock

data/Gemfile

@@ -1,5 +1,3 @@
 source 'https://rubygems.org'
 
-gemspec
-
-gem 'redis'
+gemspec

data/README.md

@@ -19,21 +19,56 @@ Or install it yourself as:
 
 ## Usage
 
-For public requests you must initialize a client of api with `BungieClient::Client`.
+This gem contains two main classes: **BungieClient::Client**, **BungieClient::Wrappers::Default** and his inherits.
+
+### BungieClient::Client
+
+It's main class that makes possible to send any requests to Bungie and connects auth module in one client. It needs for public/private requests to Bungie API.
+
+**For this you should initialize your client for the next example:**
 
 ~~~~ruby
-client = BungieClient::Client.new :api_key => '1234'
+@client = BungieClient::Client.new(
+  :api_key => 'YOUR_API_KEY',
+  :username => 'test@test.test',
+  :password => '1234',
+  :type     => 'psn'
+)
 ~~~~
 
-The option `api_key` only necessary for this class and API. For getting API key, please visit the [bungie page](https://www.bungie.net/en/user/api).
+**or simply:**
+
+~~~~ruby
+@client = BungieClient::Client.new :api_key => 'YOUR_API_KEY'
+~~~~
+
+* The option `api_key` only necessary for this class and API. For getting API key, please visit the [bungie page](https://www.bungie.net/en/user/api).
+* After it you can send your request to [Bungie Endpoint](http://destinydevs.github.io/BungieNetPlatform/docs/Endpoints).
+* The full information about classes and modules and their methods you can find in yard-comments and [rubydoc](http://www.rubydoc.info/gems/bungie_client).
+
+#### How it initialized:
+
+* Before working the client tries to authenticate in bungie, if you pass `username` and `password` option with account data, and after it uses cookies for next requests.
+* If you want to store your cookies in any place you can define they with `cookies` option without authentication.
+* After this operations your client is done for usage.
+
+> The authentication optional for client, it requires only `api_key` in your hash for initializer.
+
+#### Sending requests
 
-After it you can send your request to [Bungie Endpoint](http://destinydevs.github.io/BungieNetPlatform/docs/Endpoints).
+**Now you can send requests, e.g. for finding user information and getting his profile:**
 
-The full information about classes and modules and their methods you can find in yard-comments and [rubydoc](http://www.rubydoc.info/gems/bungie_client).
+~~~~ruby
+@client.get_response "Destiny/SearchDestinyPlayer/2/RuBAN-GT"
+~~~~
+
+#### Note
+
+* For requests optimization you should use any caching of your requests.
 
 ### BungieClient::Auth
 
-This module has two methods: authentication in bungie.net by PSN or Xbox Live and checking this authentication with cookies that was returned early.
+This module has two methods: authentication in bungie.net by *PSN* or *Xbox Live* and checking this authentication with cookies that was returned early.
 
 **Example:**
 
@@ -45,126 +80,34 @@ jar = BungieClient::Auth.auth  'example@mail.com', 'example', 'psn'
 p BungieClient::Auth.auth_possible? (jar || [])
 ~~~~
 
-### BungieClient::Cache
+### BungieClient::Wrappers::Default
 
-It's class created for easy wrapping another cache clients, e.g. [Redis](https://github.com/redis/redis-rb).
+If you don't like long code as for me you should use **Wrappers**. It's classes can call api services with dynamically generated methods with snake case like name services. Also it can change url parameters to needed values and in inherits of this class it can be do automatically.
 
-**Examples of initialization:**
+The initialization of **Wrappers::Default** is similar to **Client**: all arguments of initializer will be passed to **Client** which is class variable of wrapper.
 
 ~~~~ruby
-require 'redis'
-
-BungieClient::Cache.new(
-  :ttl    => 900,
-  :client => Redis.new,
-  :get    => Proc.new { |c, key| c.get key },
-  :set    => Proc.new { |c, key, value, ttl| c.setex key, ttl, value }
-)
+@wrapper = BungieClient::Wrappers::Default.new :api_key => 'YOUR_API_KEY'
 ~~~~
 
-**For Rails wrapper:**
+Now you can sending your requests with beautiful and effective code:
 
 ~~~~ruby
-BungieClient::Cache.new(
-  :ttl    => @ttl,
-  :client => Rails.cache,
-  :get    => Proc.new { |c, key| c.read key },
-  :set    => Proc.new { |c, key, value, ttl| c.write key, value, expires_in: ttl }
-)
+@wrapper.search_destiny_player :membershipType => '2', :displayName => 'RuBAN-GT'
 ~~~~
 
-### BungieClient::Client
-
-It's main class that makes possible to send any requests to Bungie and connects cache wrapper and auth module in one client.
-
-**For this you should initialize your client for the next example:**
+If you need **more** you can define your own wrappers such as **Wrappers::User**:
 
 ~~~~ruby
-client = BungieClient::Client.new(
+@user = BungieClient::Wrappers::User.new(
   :api_key => 'YOUR_API_KEY',
-  :authentication => true,
-  :username => 'test@test.test',
-  :password => '1234',
-  :type     => 'psn',
-  :cache => BungieClient::Cache.new(
-    :ttl    => 900,
-    :client => Redis.new,
-    :get    => Proc.new { |c, key| c.get key },
-    :set    => Proc.new { |c, key, value, ttl| c.setex key, ttl, value }
-  )
+  :display_name => 'RuBAN-GT',
+  :membership_type => '2'
 )
-~~~~
-
-#### How it initialized:
 
-* Before working the client tries to authenticate in bungie, if you pass `authentication` option with account data, and after it uses cookies for next requests.
-* If store your cookies in any place you can define they with `cookies` option without `authentication`.
-* For requests optimization you should use caching of your requests defined `BungieClient::Cache` in `cache` option.
-* After this operations your client is done for usage.
-
-> The authentication and caching are optional for client, it requires only `api_key` in your hash.
-
-#### Sending requests
-
-**Now you can send requests, e.g. for finding user information and getting his profile:**
-
-~~~~ruby
-# search account
-s = client.get_response "Destiny/SearchDestinyPlayer/2/RuBAN-GT"
-
-p s = s.first if !s.nil? && s.length == 1
-
-# get profile with characters
-p client.get_response "Destiny/#{s['membershipType']}/Account/#{s['membershipId']}" unless s.nil?
-~~~~
-
-## One sample of Rails integration
-
-If you want to work with Rails you can create easy wrapper, such as:
-
-~~~~ ruby
-require 'bungie_client'
-
-class RailsBungieWrapper
-  class << self
-    def api_key=(value)
-      @api_key = value
-    end
-    def ttl=(value)
-      @ttl = value
-    end
-
-    def init
-      yield(self) if block_given?
-    end
-
-    def client
-      return @client unless @client.nil?
-
-      @client = BungieClient::Client.new(
-        :api_key => @api_key,
-        :cache => BungieClient::Cache.new(
-          :ttl    => @ttl,
-          :client => Rails.cache,
-          :get    => Proc.new { |c, key| c.read key },
-          :set    => Proc.new { |c, key, value, ttl| c.write key, value, expires_in: ttl }
-        )
-      )
-    end
-  end
-end
+@user.search_destiny_player
 ~~~~
 
-After it, you should add your initializer to `config\initializers`:
-
-~~~~ruby
-RailsBungieWrapper.init do |config|
-  config.api_key = '1234'
-end
-~~~~
-
-In next operations the `RailsBungieWrapper.client` will be available for calls.
-
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/RuBAN-GT/bungie_client. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
@@ -176,3 +119,7 @@ The gem is available as open source under the terms of the [MIT License](http://
 ## Fireteam
 
 If you want to fight with Oryx with me or create any interesting applications for Destiny, you can add me ([https://www.bungie.net/en/Profile/254/12488384](https://www.bungie.net/en/Profile/254/12488384)).
+
+## Note
+
+* In the source code you can fine `services_parser.rb`. It's script created for getting full list of Bungie API services, for result it generates `services.yml` in lib.

data/bungie_client.gemspec

@@ -18,9 +18,12 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.required_ruby_version = "~> 2.3.0"
+
   spec.add_development_dependency "bundler", "~> 1.12"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
+
   spec.add_development_dependency "hashie", "~> 3.4"
   spec.add_development_dependency 'mechanize', "~> 2.7", ">= 2.7.0"
 end

data/examples/client_usage.rb

@@ -1,17 +1,10 @@
 $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
 
 require 'bungie_client'
-require 'redis'
 
 # init client
 client = BungieClient::Client.new(
-  :api_key => '1234',
-  :cache => BungieClient::Cache.new(
-    :ttl    => 900,
-    :client => Redis.new,
-    :get    => Proc.new { |c, key| c.get key },
-    :set    => Proc.new { |c, key, value, ttl| c.setex key, ttl, value }
-  )
+  :api_key => 'YOUR_API_KEY'
 )
 
 # search account

data/examples/wrapper_usage.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+
+require 'bungie_client'
+
+# init client
+@user = BungieClient::Wrappers::User.new(
+  :api_key => 'YOUR_API_KEY',
+  :display_name => 'RuBAN-GT',
+  :membership_type => '2'
+)
+
+p @user.get_bungie_account.keys

data/lib/bungie_client.rb

@@ -5,4 +5,6 @@ require "mechanize"
 require "bungie_client/version"
 require "bungie_client/auth"
 require "bungie_client/client"
-require "bungie_client/cache"
+require "bungie_client/service"
+require "bungie_client/wrappers/default"
+require "bungie_client/wrappers/user"

data/lib/bungie_client/auth.rb

@@ -37,12 +37,16 @@ module BungieClient::Auth
     # @return [Mechanize::CookieJar|nil]
     def auth(username, password, type = 'psn')
       # client init
-      agent = Mechanize.new
+      agent = Mechanize.new do |config|
+        config.open_timeout = 60
+        config.read_timeout = 60
+        config.idle_timeout = 120
+      end
 
       # getting index page
       agent.get 'https://www.bungie.net/' do |page|
         result = nil
-        link = page.link_with :text => search_query(type)
+        link   = page.link_with :text => search_query(type)
 
         unless link.nil?
           # call auth page
@@ -65,7 +69,7 @@ module BungieClient::Auth
           else
             # ms wanted enabled js, but we can send form without it
             ppft = login.body.match(/name\="PPFT"(.*)value\="(.*?)"/)
-            url = login.body.match(/urlPost\:'(.*?)'/)
+            url  = login.body.match(/urlPost\:'(.*?)'/)
 
             if !ppft.nil? && !url.nil?
               result = agent.post url.to_a.last,

data/lib/bungie_client/client.rb

@@ -11,12 +11,30 @@ class BungieClient::Client
     "#{BUNGIE_URI}/#{uri.sub(/^\//, '').sub(/\/$/, '')}/"
   end
 
+  # Format answer from bungie
+  #
+  # @param [String] response
+  #
+  # @return [Hashie::Mash]
+  def self.parse_response(response)
+    if !response.nil? && response != ''
+      response = JSON.parse response
+
+      if response.is_a?(Hash) && !response['Response'].nil? && response['ErrorCode'] == 1
+        response = Hashie::Mash.new response
+
+        return response['Response']
+      end
+    end
+
+    Hashie::Mash.new
+  end
+
   attr_reader :api_key
   attr_reader :username
   attr_reader :password
   attr_reader :type
   attr_reader :agent
-  attr_reader :cache
 
   # Init client
   #
@@ -26,9 +44,7 @@ class BungieClient::Client
   #
   # @param [Hash] options
   # @option options [String] :api_key
-  # @option options [Array] :cookies with [HTTP::Cookie]
-  # @option options [BungieClient::Cache] :cache client for saving respones
-  # @option options [Boolean] :authentication makes authentication with next three field for getting cookies for private requests
+  # @option options [Array|CookieJar] :cookies with [HTTP::Cookie] or [CookieJar]
   # @option options [String] :username username for authentication, necessary if set :authenticate
   # @option options [String] :password password of user, necessary if set :authenticate
   # @option options [String] :type of account, it can be 'psn' or 'live'
@@ -42,59 +58,32 @@ class BungieClient::Client
       @api_key = options[:api_key].to_s
     end
 
-    # init @cache
-    unless options[:cache].nil?
-      if options[:cache].is_a? BungieClient::Cache
-        @cache = options[:cache]
-      else
-        raise 'Cache client must be inhereted from [BungieClient::Cache].'
-      end
-    end
-
     # init @agent
-    @agent = Mechanize.new
-
-    # make authentication
-    if options[:authentication]
-      @username = options[:username]  if options[:username].is_a? String
-      @password = options[:password]  if options[:password].is_a? String
-      @type     = options[:type].to_s if ['psn', 'live'].include? options[:type].to_s
-
-      cookies = BungieClient::Auth.auth @username, @password, (@type || 'psn')
-
-      if cookies.nil?
-        raise "Wrong authentication. Check your account data."
-      else
-        @agent.cookie_jar = cookies
-      end
+    @agent = Mechanize.new do |config|
+      config.read_timeout = 5
     end
 
     # merge cookies with options
     if BungieClient::Auth.valid_cookies? options[:cookies], true
-      cookies = (options[:cookies].is_a? Array) ? cookies : cookies.cookies
+      cookies = (options[:cookies].is_a? CookieJar) ? options[:cookies].cookies : options[:cookies]
 
       cookies.each do |cookie|
         @agent.cookie_jar.add cookie
       end
     end unless options[:cookies].nil?
-  end
 
-  # Check options for allowing getting of cache
-  #
-  # @param [Hash] options of cache
-  #
-  # @return [Boolean]
-  def allow_get_cache(options = {})
-    allow_set_cache(options) && options[:cache_rewrite] != true
-  end
+    # make authentication and save new cookies in client
+    unless options[:username].nil? || options[:password].nil?
+      jar = BungieClient::Auth.auth options[:username].to_s, options[:password].to_s, (options[:type].to_s || 'psn')
 
-  # Check options for allowing setting of cache
-  #
-  # @param [Hash] options of cache
-  #
-  # @return [Boolean]
-  def allow_set_cache(options = {})
-    !@cache.nil? && options[:cache_none] != true
+      if jar.nil?
+        raise "Wrong authentication. Check your account data."
+      else
+        jar.cookies.each do |cookie|
+          @agent.cookie_jar.add cookie
+        end
+      end
+    end
   end
 
   # Get response from bungie services
@@ -109,38 +98,14 @@ class BungieClient::Client
     @agent.get(self.class.request_uri(uri), parameters, nil, headers).body rescue nil
   end
 
-  # Get Response field after get request to bungie
+  # Get Response field after sending GET request to bungie
   #
   # @param [String] uri
   # @param [Hash|Array] parameters for http-query
-  # @param [Hash] options for cache such as:
-  # @option options [Boolean] :cache_none - disable response caching
-  # @option options [Boolean] :cache_rewrite - update cache value
-  # @option options [Integer] :cache_ttl - special cache ttl
-  # @option options [Boolean] :cache_only - allow get result only from cache
   #
-  # @return [Hash|nil]
-  def get_response(uri, parameters = {}, options = {})
-    if allow_get_cache options
-      result = @cache.get "#{uri}+#{parameters}"
-
-      return result unless result.nil?
-    end
-    return nil if options[:cache_only]
-
-    result = get uri, parameters
-
-    if !result.nil? && result != ''
-      result = JSON.parse result
-
-      if result.is_a?(Hash) && !result['Response'].nil? && result['ErrorCode'] == 1
-        result = Hashie::Mash.new result
-
-        @cache.set "#{uri}+#{parameters}", result['Response'], options[:cache_ttl] if allow_set_cache options
-
-        result['Response']
-      end
-    end
+  # @return [Hashie::Mash]
+  def get_response(uri, parameters = {})
+    self.class.parse_response get(uri, parameters)
   end
 
   # Post data to bungie services
@@ -158,19 +123,9 @@ class BungieClient::Client
   # @param [String] uri
   # @param [Hash] query for post
   #
-  # @return [Hash|nil]
+  # @return [Hashie::Mash]
   def post_response(uri, query = {})
-    result = post uri, query
-
-    if !result.nil? && result != ''
-      result = JSON.parse result
-
-      if result.is_a?(Hash) && !result['Response'].nil? && result['ErrorCode'] == 1
-        result = Hashie::Mash.new result
-
-        result['Response']
-      end
-    end
+    self.class.parse_response post(uri, query)
   end
 
   protected