bungie_client 0.6.0 → 1.0.0

data/lib/bungie_client/version.rb

@@ -1,3 +1,3 @@
 module BungieClient
-  VERSION = '0.6.0'
+  VERSION = '1.0.0'
 end

data/lib/bungie_client/wrappers/default.rb

@@ -0,0 +1,84 @@
+# 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.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 = {})
+      # try to fine 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

data/lib/bungie_client/wrappers/user.rb

@@ -0,0 +1,53 @@
+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
+    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/underscore.rb

@@ -0,0 +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
+end

data/services_parser.rb

@@ -0,0 +1,33 @@
+# This script can parse the list of bungie services from *destinydevs.github.io* for client.
+
+require 'yaml'
+require 'hashie'
+require 'mechanize'
+require 'underscore'
+
+# preset
+client = Mechanize.new
+url = 'http://destinydevs.github.io/BungieNetPlatform/docs/Endpoints'
+services = {}
+
+# get services
+client.get url do |page|
+  trs = page.parser.search '.container .table tbody tr'
+
+  trs.each do |tr|
+    tds = tr.search 'td'
+
+    next if tds.nil? || tds[1].nil?
+
+    services[tds[1].text.underscore] = {
+      :name => tds[1].text,
+      :method => (tds[0]&.text.downcase || 'get'),
+      :endpoint => (tds[2]&.text || '')
+    }
+  end unless trs.nil?
+end
+
+# save yaml
+File.open "#{File.dirname(__FILE__)}/lib/bungie_client/services.yml", 'w' do |f|
+  f.write services.to_yaml
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bungie_client
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Dmitry Ruban
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-09-30 00:00:00.000000000 Z
+date: 2016-11-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -108,11 +108,17 @@ files:
 - bungie_client.gemspec
 - examples/auth_usage.rb
 - examples/client_usage.rb
+- examples/wrapper_usage.rb
 - lib/bungie_client.rb
 - lib/bungie_client/auth.rb
-- lib/bungie_client/cache.rb
 - lib/bungie_client/client.rb
+- 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/underscore.rb
+- services_parser.rb
 homepage: https://github.com/RuBAN-GT/bungie_client
 licenses:
 - MIT
@@ -123,9 +129,9 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/lib/bungie_client/cache.rb

@@ -1,53 +0,0 @@
-class BungieClient::Cache
-  attr_reader :client
-  attr_reader :ttl
-
-  # Get value
-  #
-  # @param [String] key
-  #
-  # @return [Object]
-  def get(key)
-    result = @get.call @client, key.to_s
-
-    Marshal.load result unless result.nil?
-  end
-
-  # Set value
-  #
-  # @param [String] key
-  # @param [Object] value it can be everything, because it serialized with [Marshal]
-  # @param [Integer|nil] ttl
-  def set(key, value, ttl = nil)
-    @set.call @client, key.to_s, Marshal.dump(value), (ttl || @ttl)
-  end
-
-  # Initialize handlers of cache client with options
-  #
-  # @param [Hash] options with
-  # @option options [Class] :client - basic object of cache client, e.g. [Redis]
-  # @option options [Proc] :get - method for getting data, it gets key of row on call
-  # @option options [Proc] :set - method for setting data, it gets key, value, ttl on call
-  # @option options [Integer] :ttl - time to live of row in cache
-  def initialize(options = {})
-    @ttl = (options[:ttl].is_a?(Integer) && options[:ttl] > 0) ? options[:ttl] : 900
-
-    if options[:client].nil?
-      raise 'You must define the client initialization.'
-    else
-      @client = options[:client]
-    end
-
-    if options[:get].is_a? Proc
-      @get = options[:get]
-    else
-      raise 'You must define the get method for caching.'
-    end
-
-    if options[:set].is_a? Proc
-      @set = options[:set]
-    else
-      raise 'You must define the set method for caching.'
-    end
-  end
-end