bungie_client 1.1.1 → 2.0.0

data/lib/bungie_client/version.rb

@@ -1,3 +1,3 @@
-module BungieClient
-  VERSION = '1.1.1'
-end
+module BungieClient
+  VERSION = '2.0.0'
+end

data/lib/bungie_client/wrappers/default.rb

@@ -1,84 +1,65 @@
-# Wrapper class for simple api requests
-module BungieClient::Wrappers
-  class Default
-    # Get list of services
-    #
-    # @see http://destinydevs.github.io/BungieNetPlatform/docs/Endpoints
-    #
-    # @return [Hash]
-    def self.services
-      return @services unless @services.nil?
-
-      @services = YAML.load_file "#{File.dirname(__FILE__)}/../services.yml" || {}
-    end
-
-    # 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 [Hash] options
-    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
-      @options = nil
-
-      @client
-    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 unless params.nil?
-
-      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 = {})
-      # try to find service
-      service = self.class.services[service]
-
-      raise NoMethodError if service.nil?
-
-      # init service
-      service = BungieClient::Service.new service
-
-      # change url
-      url = self.fill_url service.endpoint, params
-
-      # send request
-      client.send "#{service.method_type}_response", url, options
-    end
-
-    def method_missing(*args)
-      call_service args[0].to_s, args[1], args[2]
-    end
-  end
-end
+# 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 +1,56 @@
-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
+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

data/lib/tasks/parse_services.rake

@@ -0,0 +1,35 @@
+require 'yaml'
+require 'hashie'
+require 'nokogiri'
+require 'open-uri'
+require 'underscore'
+
+# This task can parse the list of bungie services from *destinydevs.github.io* for client.
+task :parse_services do
+  # preset
+  services = {}
+  response = Nokogiri::HTML open('http://destinydevs.github.io/BungieNetPlatform/docs/Endpoints')
+
+  # get services
+  response.search('.container .table tbody tr').each do |tr|
+    tds = tr.search 'td'
+
+    next if tds.nil? || tds[1].nil?
+
+    service = {
+      :name => tds[1].text,
+      :method => (tds[0]&.text.downcase || 'get'),
+      :endpoint => (tds[2]&.text || '')
+    }
+    service[:endpoint].slice! 0
+
+    services[tds[1].text.underscore] = service
+  end
+
+  # save yaml
+  File.open "#{File.dirname(__FILE__)}/../bungie_client/services.yml", 'w' do |f|
+    f.write services.to_yaml
+  end
+
+  p 'Services were generated...'
+end

data/lib/underscore.rb

@@ -1,10 +1,10 @@
-class String
-  # Transform string to snake case
-  def underscore
-    self.gsub(/::/, '/').
-      gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
-      gsub(/([a-z\d])([A-Z])/,'\1_\2').
-      tr("- ", "_").
-      downcase
-  end
+class String
+  # Transform string to snake case
+  def underscore
+    self.gsub(/::/, '/').
+      gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+      gsub(/([a-z\d])([A-Z])/,'\1_\2').
+      tr("- ", "_").
+      downcase
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bungie_client
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 2.0.0
 platform: ruby
 authors:
 - Dmitry Ruban
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-01-28 00:00:00.000000000 Z
+date: 2017-06-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: multi_json
   requirement: !ruby/object:Gem::Requirement
@@ -81,25 +95,47 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.4'
 - !ruby/object:Gem::Dependency
-  name: mechanize
+  name: httpclient
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.7'
-    - - ">="
+        version: '2.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.7.0
+        version: '0.12'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.7'
-    - - ">="
+        version: '0.12'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.7.0
+        version: '0'
 description: This gem makes possible to use Bungie API (and Destiny API too). It can
   be useful, if you decide create your application for Destiny Game (https://www.bungie.net/en/pub/AboutDestiny).
 email:
@@ -110,6 +146,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -118,8 +155,6 @@ files:
 - bin/console
 - bin/setup
 - bungie_client.gemspec
-- examples/client_usage.rb
-- examples/wrapper_usage.rb
 - lib/bungie_client.rb
 - lib/bungie_client/client.rb
 - lib/bungie_client/service.rb
@@ -127,8 +162,8 @@ files:
 - lib/bungie_client/version.rb
 - lib/bungie_client/wrappers/default.rb
 - lib/bungie_client/wrappers/user.rb
+- lib/tasks/parse_services.rake
 - lib/underscore.rb
-- services_parser.rb
 homepage: https://github.com/RuBAN-GT/bungie_client
 licenses:
 - MIT

data/examples/client_usage.rb

@@ -1,16 +0,0 @@
-$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
-
-require 'bungie_client'
-
-# init client
-client = BungieClient::Client.new(
-  :api_key => 'YOUR_API_KEY'
-)
-
-# 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?