bungie_client 2.1.2.1 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 851207be796c415e6fa8ed192403ea7e49408e2d
-  data.tar.gz: 775fb8b8253cfaf97f7ecd7a41c75676c494e2f6
+SHA256:
+  metadata.gz: df5f143d312b49b9319a8285899ae48ec401857195ae60ca1162fe9e5a52fb45
+  data.tar.gz: b80230dae35564621e550e4c936436d576bc31cd355818d3e80c08931dbd879a
 SHA512:
-  metadata.gz: b9c75608b9725bcbf82c588f6490caf082ed3a252361cd02bda5fd2b7216f2b95d6da56629e88815eff01f7f1391f846e62caf29b04a1d9dd81009228af9a91b
-  data.tar.gz: 5d3ced710095d04152499232831db7aacf13c90913f958f4de34b8466e7fec576e725ebeb606364d6e9187d6dbc6b0b8f41dd6d7b1151d492d7bfdf2a94211f8
+  metadata.gz: efe67dd8d9b270984fc1918e88574fb4ed8c6aee0a170da2d58ca978a837d17f103ae90a3a909a902ae332e998ed244061d40541598ec44d7e02b29d5c93b13f
+  data.tar.gz: a657040b4afc0271efeb4770c919ae80d75fb83d4041d0808a27386087eb94844be3171b98e59d55acffe7d79086de563e00ea3ac1c6196153a9a9e73114a871

data/.circleci/config.yml

@@ -0,0 +1,26 @@
+version: 2.1
+jobs:
+  test:
+    parameters:
+      ruby-version:
+        type: string
+    docker:
+      - image: << parameters.ruby-version >>
+    steps:
+      - checkout
+      - run:
+          name: Gem install bundler
+          command: gem update --system && gem install bundler
+      - run:
+          name: Bundle install
+          command: bundle install --jobs=4 --retry=3 --path vendor/bundle
+      - run:
+          name: Run tests
+          command: bundle exec rake
+workflows:
+  all-tests:
+    jobs:
+      - test:
+          matrix:
+            parameters:
+              ruby-version: ["ruby:3.0.1", "ruby:2.7.3", "ruby:2.6.7"]

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Change Log
 
+## 2.2.0
+
+Thank you [brrusselburg](https://github.com/brrusselburg) for this release.
+
+* Actualised dependencies ([#2](https://github.com/RuBAN-GT/bungie_client/pull/2))
+* Code style updates
+
 ## 2.1.3
 
 Hotfix

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 gemspec

data/Rakefile

@@ -1,8 +1,10 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec
 
 Dir.glob('lib/tasks/*.rake').each { |r| import r }

data/bin/console

@@ -1,7 +1,8 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-require "bundler/setup"
-require "bungie_client"
+require 'bundler/setup'
+require 'bungie_client'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -10,5 +11,5 @@ require "bungie_client"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start

data/bungie_client.gemspec

@@ -1,31 +1,33 @@
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'bungie_client/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "bungie_client"
+  spec.name          = 'bungie_client'
   spec.version       = BungieClient::VERSION
-  spec.authors       = ["Dmitry Ruban"]
-  spec.email         = ["dkruban@gmail.com"]
+  spec.authors       = ['Dmitry Ruban']
+  spec.email         = ['dkruban@gmail.com']
 
-  spec.summary       = "This gem makes possible to use Bungie API (and Destiny API too)."
-  spec.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)."
-  spec.homepage      = "https://github.com/RuBAN-GT/bungie_client"
-  spec.license       = "MIT"
+  spec.summary       = 'This gem makes possible to use Bungie API (and Destiny API too).'
+  spec.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).'
+  spec.homepage      = 'https://github.com/RuBAN-GT/bungie_client'
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  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 "webmock", "~> 3.0"
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'webmock', '~> 3.0'
 
-  spec.add_runtime_dependency "multi_json", "~> 1.12"
-  spec.add_runtime_dependency "hashie", "~> 3.4"
-  spec.add_runtime_dependency "httpclient", '~> 2.8'
-  spec.add_runtime_dependency "faraday", "~> 0.11"
-  spec.add_runtime_dependency "faraday_middleware", "~> 0"
+  spec.add_runtime_dependency 'faraday', '~> 0.11'
+  spec.add_runtime_dependency 'faraday_middleware', '~> 0'
+  spec.add_runtime_dependency 'hashie', '~> 3.4'
+  spec.add_runtime_dependency 'httpclient', '~> 2.8'
+  spec.add_runtime_dependency 'multi_json', '~> 1.12'
 end

data/lib/bungie_client/client.rb

@@ -1,82 +1,92 @@
+# frozen_string_literal: true
+
 # Class Client for GET/POST requests to Bungie.
 # For specific HTTP operations you can use @conn [Faraday].
-class BungieClient::Client
-  BUNGIE_URI = 'https://www.bungie.net/Platform'
+module BungieClient
+  class Client
+    BUNGIE_URI = 'https://www.bungie.net/Platform'
 
-  # Format answer from Bungie
-  #
-  # @param [String] response
-  #
-  # @return [Mash]
-  def self.parse(response)
-    response = MultiJson.load response rescue {}
+    # Format answer from Bungie
+    #
+    # @param [String] response
+    #
+    # @return [Mash]
+    def self.parse(response)
+      response = begin
+        MultiJson.load response
+      rescue StandardError
+        {}
+      end
 
-    Hashie::Mash.new response
-  end
+      Hashie::Mash.new response
+    end
 
-  attr_reader :api_key
-  attr_reader :token
-  attr_reader :conn
+    attr_reader :api_key, :token, :conn
 
-  # Init client
-  #
-  # @see https://www.bungie.net/en/user/api
-  #
-  # Initialize client for bungie api throw hash:
-  #
-  # @param [Hash] options
-  # @option options [String] :api_key
-  # @option options [String] :token is authorization token from oauth2
-  def initialize(options)
-    # Checking options and @api_key
-    raise 'Wrong options: It must be Hash.' unless options.is_a? Hash
+    # Init client
+    #
+    # @see https://www.bungie.net/en/user/api
+    #
+    # Initialize client for bungie api throw hash:
+    #
+    # @param [Hash] options
+    # @option options [String] :api_key
+    # @option options [String] :token is authorization token from oauth2
+    def initialize(options)
+      # Checking options and @api_key
+      raise 'Wrong options: It must be Hash.' unless options.is_a? Hash
 
-    if options[:api_key].nil?
-      raise "The API-key required for every request to bungie."
-    else
-      @api_key = options[:api_key].to_s
-    end
+      if options[:api_key].nil?
+        raise 'The API-key required for every request to bungie.'
+      else
+        @api_key = options[:api_key].to_s
+      end
 
-    # Set token
-    @token = options[:token].to_s unless options[:token].nil?
+      # Set token
+      @token = options[:token].to_s unless options[:token].nil?
 
-    # Init connection
-    @conn = Faraday.new :url => BUNGIE_URI do |builder|
-      builder.headers['Content-Type']  = 'application/json'
-      builder.headers['Accept']        = 'application/json'
-      builder.headers['X-API-Key']     = @api_key
-      builder.headers['Authorization'] = "Bearer #{@token}" unless @token.nil?
+      # Init connection
+      @conn = Faraday.new url: BUNGIE_URI do |builder|
+        builder.headers['Content-Type']  = 'application/json'
+        builder.headers['Accept']        = 'application/json'
+        builder.headers['X-API-Key']     = @api_key
+        builder.headers['Authorization'] = "Bearer #{@token}" unless @token.nil?
 
-      builder.options.timeout      = 5
-      builder.options.open_timeout = 2
+        builder.options.timeout      = 5
+        builder.options.open_timeout = 2
 
-      builder.use FaradayMiddleware::FollowRedirects, :limit => 5
+        builder.use FaradayMiddleware::FollowRedirects, limit: 5
 
-      builder.adapter :httpclient
+        builder.adapter :httpclient
+      end
     end
-  end
 
-  # Get request to bungie service
-  #
-  # @see http://destinydevs.github.io/BungieNetPlatform/docs/Endpoints
-  #
-  # @param [String] url
-  # @param [Hash] parameters for http-query
-  # @param [Hash] headers
-  #
-  # @return [Mash]
-  def get(url, parameters = {}, headers = {})
-    self.class.parse @conn.get(url, parameters, headers).body rescue Hashie::Mash.new
-  end
+    # Get request to bungie service
+    #
+    # @see http://destinydevs.github.io/BungieNetPlatform/docs/Endpoints
+    #
+    # @param [String] url
+    # @param [Hash] parameters for http-query
+    # @param [Hash] headers
+    #
+    # @return [Mash]
+    def get(url, parameters = {}, headers = {})
+      self.class.parse @conn.get(url, parameters, headers).body
+    rescue StandardError
+      Hashie::Mash.new
+    end
 
-  # Post data to Bungie services
-  #
-  # @param [String] url
-  # @param [Hash] query
-  # @param [Hash] headers
-  #
-  # @return [Mash]
-  def post(url, query = {}, headers = {})
-    self.class.parse @conn.post(url, query, headers).body rescue Hashie::Mash.new
+    # Post data to Bungie services
+    #
+    # @param [String] url
+    # @param [Hash] query
+    # @param [Hash] headers
+    #
+    # @return [Mash]
+    def post(url, query = {}, headers = {})
+      self.class.parse @conn.post(url, query, headers).body
+    rescue StandardError
+      Hashie::Mash.new
+    end
   end
 end

data/lib/bungie_client/service.rb

@@ -1,30 +1,34 @@
+# frozen_string_literal: true
+
 # Simple class for service structure
-class BungieClient::Service
-  attr_reader :type, :name, :endpoint
+module BungieClient
+  class Service
+    attr_reader :type, :name, :endpoint
 
-  # Get list of services
-  #
-  # @see http://destinydevs.github.io/BungieNetPlatform/docs/Endpoints
-  #
-  # @return [Hash]
-  def self.services
-    return @services unless @services.nil?
+    # 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
+      @services = YAML.load_file "#{File.dirname(__FILE__)}/services.yml" || {}
+    end
 
-  # Initialize service by name with snake case style
-  #
-  # @example service =
-  #
-  # @param [String] name
-  def initialize(name)
-    service = self.class.services[name]
+    # Initialize service by name with snake case style
+    #
+    # @example service =
+    #
+    # @param [String] name
+    def initialize(name)
+      service = self.class.services[name]
 
-    raise 'Undefined service' if service.nil?
+      raise 'Undefined service' if service.nil?
 
-    @type     = service[:method]
-    @name     = service[:name]
-    @endpoint = service[:endpoint]
+      @type     = service[:method]
+      @name     = service[:name]
+      @endpoint = service[:endpoint]
+    end
   end
 end

data/lib/bungie_client/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module BungieClient
-  VERSION = '2.1.2.1'
+  VERSION = '2.2.0'
 end

data/lib/bungie_client/wrapper.rb

@@ -1,64 +1,72 @@
+# frozen_string_literal: true
+
 # 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]
+module BungieClient
+  class 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
-  end
 
-  # Get wrapper client
-  #
-  # @return [BungieClient::Client]
-  def client
-    return @client unless @client.nil?
+    # 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
+      @client = BungieClient::Client.new @options
     end
 
-    url
-  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
 
-  # 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)
-  # @param [Hash] headers
-  #
-  # @return [Hashie::Mash]
-  def call_service(service, params = {}, options = {}, headers = {})
-    service = BungieClient::Service.new service rescue raise NoMethodError
+      url
+    end
 
-    # change url
-    url = self.fill_url service.endpoint, params
+    # 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)
+    # @param [Hash] headers
+    #
+    # @return [Hashie::Mash]
+    def call_service(service, params = {}, options = {}, headers = {})
+      service = begin
+        BungieClient::Service.new service
+      rescue StandardError
+        raise NoMethodError
+      end
 
-    # send request
-    client.send service.type, url, options, headers
-  end
+      # change url
+      url = fill_url service.endpoint, params
 
-  def method_missing(*args)
-    call_service args[0].to_s, args[1] || {}, args[2] || {}, args[3] || {}
+      # send request
+      client.send service.type, url, options, headers
+    end
+
+    def method_missing(*args)
+      call_service args[0].to_s, args[1] || {}, args[2] || {}, args[3] || {}
+    end
   end
 end

data/lib/bungie_client.rb

@@ -1,9 +1,11 @@
-require "multi_json"
-require "hashie"
-require "faraday"
-require "faraday_middleware"
+# frozen_string_literal: true
 
-require "bungie_client/version"
-require "bungie_client/client"
-require "bungie_client/service"
-require "bungie_client/wrapper"
+require 'multi_json'
+require 'hashie'
+require 'faraday'
+require 'faraday_middleware'
+
+require 'bungie_client/version'
+require 'bungie_client/client'
+require 'bungie_client/service'
+require 'bungie_client/wrapper'

data/lib/tasks/parse_services.rake

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'yaml'
 require 'hashie'
 require 'nokogiri'
@@ -17,9 +19,9 @@ task :parse_services do
     next if tds.nil? || tds[1].nil?
 
     service = {
-      :name => tds[1].text,
-      :method => (tds[0]&.text.downcase || 'get'),
-      :endpoint => (tds[2]&.text || '')
+      name: tds[1].text,
+      method: (tds[0]&.text.downcase || 'get'),
+      endpoint: (tds[2]&.text || '')
     }
     service[:endpoint].slice! 0
 

data/lib/underscore.rb

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 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
+    gsub(/::/, '/')
+      .gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
+      .gsub(/([a-z\d])([A-Z])/, '\1_\2')
+      .tr('- ', '_')
+      .downcase
   end
-end
+end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: bungie_client
 version: !ruby/object:Gem::Version
-  version: 2.1.2.1
+  version: 2.2.0
 platform: ruby
 authors:
 - Dmitry Ruban
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2017-09-06 00:00:00.000000000 Z
+date: 2021-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -67,75 +67,75 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: multi_json
+  name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: '0.11'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: '0.11'
 - !ruby/object:Gem::Dependency
-  name: hashie
+  name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: httpclient
+  name: hashie
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.8'
+        version: '3.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.8'
+        version: '3.4'
 - !ruby/object:Gem::Dependency
-  name: faraday
+  name: httpclient
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.11'
+        version: '2.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.11'
+        version: '2.8'
 - !ruby/object:Gem::Dependency
-  name: faraday_middleware
+  name: multi_json
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.12'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.12'
 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:
@@ -144,6 +144,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".circleci/config.yml"
 - ".gitignore"
 - ".travis.yml"
 - CHANGELOG.md
@@ -167,7 +168,7 @@ homepage: https://github.com/RuBAN-GT/bungie_client
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -182,9 +183,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.12
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
 summary: This gem makes possible to use Bungie API (and Destiny API too).
 test_files: []