bungie_client 2.0.1 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ef251eb8b1402cfa8136e4342953d6506f19fc7d
-  data.tar.gz: 552f172ee73e31f5f43588231e812e16a59034ed
+  metadata.gz: 3d9e596bd5517cf5251a6143166bcbe7f2766218
+  data.tar.gz: c23a7997ea88fbaa849690ab27f3eee8a4b3ccd7
 SHA512:
-  metadata.gz: bf4caa81432ec97df9bd4d7b0d85589a3f6867e983ef31904fe7a8e43c185aea2fd66f23f1f5f8ab6f5cd2298553b2233b82790bc4e17a91263e25f67cd7585b
-  data.tar.gz: 5d06e54e1f1f251fa796ce8bee084266ff0811eda8bafc5d1838d4dc1cb90c47a0547917eeefa1cecc46269bed8da001cae67548fdf3a77ab1d0aeee5bc230cc
+  metadata.gz: 373f0c3db1c20562c0454fbc02026c776b8066a206d07a8d5b530958276b430995aa442e363eecaf623b80bd5537f778beed6b81883e55e1b52d0de02c9cd155
+  data.tar.gz: 6d3440350b42f774be43b7d957288adf1d5aa6e336efda40b34caa805c3f6eda5dfc658a3a9175a97a3c0786810af83b53472adf217524e91a66e9cb1b9e8e54

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 # Change Log
 
+## 2.1.0 (2017-06-25)
+
+### Fixes
+
+* Empty hashes for `BungieClient::Wrapper#call_service` method.
+
+### Changes
+
+* Move `Default` class to `BungieClient::Wrapper`.
+
+### Removed
+
+* `BungieClient::Wrappers` namespace with `User` class
 
 ## 2.0.0 (2017-06-21)
 
@@ -17,5 +30,6 @@
 * Move services generator to Rake tasks.
 
 ### Removed
+
 * `get_response` and `post_response` methods, now it works in default `get` and `post` method from `BungieClient::Client`.
 * cookies support in `BungieClient::Client`.

data/README.md

@@ -26,24 +26,24 @@ This gem contains two main classes: **BungieClient::Client**, **BungieClient::Wr
 
 It's main class that makes possible to send any requests to Bungie.
 
-**For this you should initialize your client for the next example:**
+**For this You should initialize your client for the next example:**
 
 ~~~~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).
+* 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:
 
-* If you want to use private API, you must get [Authorization token](https://www.bungie.net/en/Help/Article/45481) from Bungie Oauth2 and set `token` option.
+* If You want to use private API, You must get [Authorization token](https://www.bungie.net/en/Help/Article/45481) from Bungie Oauth2 and set `token` option.
 * After this operations your client is done for usage.
 
 #### Sending requests
 
-**Now you can send requests, e.g. for finding user information and getting his profile:**
+**Now You can send requests, e.g. for finding user information and getting his profile:**
 
 ~~~~ruby
 client.get "Destiny/SearchDestinyPlayer/2/RuBAN-GT"
@@ -51,36 +51,24 @@ client.get "Destiny/SearchDestinyPlayer/2/RuBAN-GT"
 
 #### Note
 
-* For requests optimization you should use any caching of your requests.
+* For requests optimization You should use any caching of your requests.
 
-### BungieClient::Wrappers::Default
+### BungieClient::Wrapper
 
-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.
+If You don't like long code as for me You should use **BungieClient::Wrapper**. It's class can call api services with dynamically generated methods with snake case like name services. Also it can change url parameters to needed values.
 
-The initialization of **Wrappers::Default** is similar to **Client**: all arguments of initializer will be passed to **Client** which is class variable of wrapper.
+The initialization of **Wrapper** is similar to **Client**: all arguments of initializer will be passed to **Client** which is class variable of wrapper.
 
 ~~~~ruby
-wrapper = BungieClient::Wrappers::Default.new :api_key => 'YOUR_API_KEY'
+wrapper = BungieClient::Wrapper.new :api_key => 'YOUR_API_KEY'
 ~~~~
 
-Now you can sending your requests with beautiful and effective code:
+Now You can sending your requests with beautiful and effective code:
 
 ~~~~ruby
 wrapper.search_destiny_player :membershipType => '2', :displayName => 'RuBAN-GT'
 ~~~~
 
-If you need **more** you can define your own wrappers such as **Wrappers::User**:
-
-~~~~ruby
-user = BungieClient::Wrappers::User.new(
-  :api_key => 'YOUR_API_KEY',
-  :display_name => 'RuBAN-GT',
-  :membership_type => '2'
-)
-
-@user.search_destiny_player
-~~~~
-
 ## 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.
@@ -91,4 +79,4 @@ 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)).
+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)).

data/lib/bungie_client.rb

@@ -6,5 +6,4 @@ require "faraday_middleware"
 require "bungie_client/version"
 require "bungie_client/client"
 require "bungie_client/service"
-require "bungie_client/wrappers/default"
-require "bungie_client/wrappers/user"
+require "bungie_client/wrapper"

data/lib/bungie_client/version.rb

@@ -1,3 +1,3 @@
 module BungieClient
-  VERSION = '2.0.1'
+  VERSION = '2.1.0'
 end

data/lib/bungie_client/wrapper.rb

@@ -0,0 +1,63 @@
+# Wrapper class for simple api requests
+class BungieClient::Wrapper
+  # Initialize wrapper with client
+  #
+  # This initializer create wrapper object with client.
+  # If you `options` contain `:client` key, it will be taken as client object [BungieClient::Client]. Otherwise it will be passed in client initializer.
+  #
+  # @see BungieClient::Client
+  #
+  # @param [BungieClient::Client] client initialized for wrapper
+  # @param [Hash] options for initialization of client
+  def initialize(options = {})
+    if options[:client].nil?
+      @options = options
+    elsif options[:client].is_a? BungieClient::Client
+      @client = options[:client]
+    end
+  end
+
+  # Get wrapper client
+  #
+  # @return [BungieClient::Client]
+  def client
+    return @client unless @client.nil?
+
+    @client = BungieClient::Client.new @options
+  end
+
+  # Change all url parameters to hash value
+  #
+  # @param [String] url
+  # @param [Hash] params
+  #
+  # @return [String]
+  def fill_url(url, params)
+    params.each do |key, value|
+      url = url.gsub "{#{key}}", value.to_s
+    end
+
+    url
+  end
+
+  # Call needed service from services list
+  #
+  # @param [String] service name in snake case
+  # @param [Hash] params service parameters
+  # @param [Hash] options for client request (get/post)
+  #
+  # @return [Hashie::Mash]
+  def call_service(service, params = {}, options = {})
+    service = BungieClient::Service.new service rescue raise NoMethodError
+
+    # change url
+    url = self.fill_url service.endpoint, params
+
+    # send request
+    client.send service.type, url, options
+  end
+
+  def method_missing(*args)
+    call_service args[0].to_s, args[1] || {}, args[2] || {}
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bungie_client
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.1.0
 platform: ruby
 authors:
 - Dmitry Ruban
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-06-21 00:00:00.000000000 Z
+date: 2017-06-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -160,8 +160,7 @@ files:
 - lib/bungie_client/service.rb
 - lib/bungie_client/services.yml
 - lib/bungie_client/version.rb
-- lib/bungie_client/wrappers/default.rb
-- lib/bungie_client/wrappers/user.rb
+- lib/bungie_client/wrapper.rb
 - lib/tasks/parse_services.rake
 - lib/underscore.rb
 homepage: https://github.com/RuBAN-GT/bungie_client

data/lib/bungie_client/wrappers/default.rb

@@ -1,65 +0,0 @@
-# Wrapper class for simple api requests
-module BungieClient::Wrappers
-  class Default
-    # Initialize wrapper with client
-    #
-    # This initializer create wrapper object with client.
-    # If you `options` contain `:client` key, it will be taken as client object [BungieClient::Client]. Otherwise it will be passed in client initializer.
-    #
-    # @see BungieClient::Client
-    #
-    # @param [BungieClient::Client] client initialized for wrapper
-    # @param [Hash] options for initialization of client
-    def initialize(options = {})
-      if options[:client].nil?
-        @options = options
-      elsif options[:client].is_a? BungieClient::Client
-        @client = options[:client]
-      end
-    end
-
-    # Get wrapper client
-    #
-    # @return [BungieClient::Client]
-    def client
-      return @client unless @client.nil?
-
-      @client = BungieClient::Client.new @options
-    end
-
-    # Change all url parameters to hash value
-    #
-    # @param [String] url
-    # @param [Hash] params
-    #
-    # @return [String]
-    def fill_url(url, params)
-      params.each do |key, value|
-        url = url.gsub "{#{key}}", value.to_s
-      end
-
-      url
-    end
-
-    # Call needed service from services list
-    #
-    # @param [String] service name in snake case
-    # @param [Hash] params service parameters
-    # @param [Hash] options for client request (get/post)
-    #
-    # @return [Hashie::Mash]
-    def call_service(service, params = {}, options = {})
-      service = BungieClient::Service.new service rescue raise NoMethodError
-
-      # change url
-      url = self.fill_url service.endpoint, params
-
-      # send request
-      client.send service.type, url, options
-    end
-
-    def method_missing(*args)
-      call_service args[0].to_s, args[1], args[2]
-    end
-  end
-end

data/lib/bungie_client/wrappers/user.rb

@@ -1,56 +0,0 @@
-module BungieClient::Wrappers
-  class User < Default
-    attr_reader :membership_type, :display_name
-
-    # Initialize wrapper with user's preset
-    #
-    # @note maybe add the `destiny_membership_id` as an alternative to `display_name`
-    #
-    # @option options [Integer] :membership_type Platform type number (xbox - 1, playstation - 2, all - 256)
-    # @option options [String] :display_name Simple user name
-    def initialize(options)
-      super
-
-      # set membershipType
-      if %w(1 2 256).include? options[:membership_type].to_s
-        @membership_type = options[:membership_type].to_s
-      else
-        @membership_type = '256'
-      end
-
-      # set displayName
-      if options[:display_name].is_a? String
-        @display_name = options[:display_name]
-      else
-        raise 'You must set user display name'
-      end
-
-      # set destinyMembershipId if needed
-      @destiny_membership_id = options[:destiny_membership_id] unless options[:destiny_membership_id].nil?
-    end
-
-    # Get DestinyMembershipId of selected user
-    def destiny_membership_id
-      return @destiny_membership_id unless @destiny_membership_id.nil?
-
-      @destiny_membership_id = call_service(
-        'get_membership_id_by_display_name',
-        {
-          :displayName =>  @display_name,
-          :membershipType => @membership_type
-        }
-      )
-    end
-
-    def fill_url(url, params)
-      params = {} unless params.is_a? Hash
-
-      params[:displayName] = @display_name
-      params[:membershipType] = @membership_type
-      params[:destinyMembershipId] = destiny_membership_id if url.include? '{destinyMembershipId}'
-      params[:membershipId] = destiny_membership_id if url.include? '{membershipId}'
-
-      super
-    end
-  end
-end