metrica_api 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8c3c643b1ea64446fe23364c2a604315c42b955d
-  data.tar.gz: 5ba637f4d9e0f9a6cb3bfe2a6f0a033a9045e1af
+  metadata.gz: 470d1d2c35f69277c4ca146eecc9543079a71e10
+  data.tar.gz: 6e8c708f47a6e2b264e28dc4a82592dae3c48f91
 SHA512:
-  metadata.gz: db478488dc9de228d540d06bc557068d339a52380ff2e5add8d21eaf56a9fd1b80acaf37d05b52cde0c3ca058f29bc9655df5e267c410c81af055705659e8e0f
-  data.tar.gz: cc951ae6daa065a07fccbe0f47f7bf165e96fa6335f78b00bb5fe1656510123ec7909919223cc473748e3597d9279077a77113244a4939ea37af5c594a86d039
+  metadata.gz: 6ad06e718c1c6c86a11840a4f11991fa847a8f5fc6a096ebd0a99ca867942aeb8cd38e7c62d5738adb0c414eef121a2bef9514c2376805c93d41612d2a3b9326
+  data.tar.gz: 15c1b357d6e2f9101aae19075b0e2ae3e12d2013b03036030074be6c598bd4f0faeeb0b7f5d715c0af964b7a5cf32596a202cfff85b8691b11b65d0cfc77999f

data/lib/metrica_api/errors/connection_error.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module MetricaApi
+class MetricaApi
   # Connection error class
   class ConnectionError < StandardError
   end

data/lib/metrica_api/errors/request_error.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module MetricaApi
+class MetricaApi
   # Request error class
   class RequestError < StandardError
   end

data/lib/metrica_api/request.rb

@@ -1,44 +1,78 @@
 # frozen_string_literal: true
 
-module MetricaApi
-  # Yandex Metrica request module
-  module Request
+class MetricaApi
+  # Yandex Metrica request
+  class Request
 
-    module_function
+    def self.call(options, params = {})
+      Request.new(options, params).call
+    end
 
-    def make_request(options, params = {})
+    def initialize(options, params = {})
+      @options = options
+      @params = params
+    end
 
-      params[:oauth_token] = options.fetch(:oauth_token)
-      response = RestClient::Request.execute(build(options, params))
-      MetricaApi.logger << response if MetricaApi.logger
-      response
+    def call
+      execute!.tap do |response|
+        if logger
+          logger << full_url
+          logger << response
+        end
+      end
     rescue RestClient::Unauthorized,
-           RestClient::Forbidden,
-           RestClient::BadRequest,
-           RestClient::ResourceNotFound => e
+      RestClient::Forbidden,
+      RestClient::BadRequest,
+      RestClient::ResourceNotFound => e
       raise MetricaApi::RequestError,
-            "url: #{build_url(options)}?#{params.to_query}, original: #{e.message}"
+            "url: #{full_url}, original: #{e.message}"
     rescue SocketError => e
       raise MetricaApi::ConnectionError, e.message
+    end
+
+    private
 
+    attr_reader :options, :params
+
+    def execute!
+      RestClient::Request.execute(rest_client_options)
     end
 
-    def build(options, params)
-      params[:oauth_token] = options.fetch(:oauth_token)
+    def rest_client_options
       {
         method: :get,
-        url: build_url(options),
-        headers: { params: params },
+        url: base_url,
+        headers: { params: params_with_token },
         log: MetricaApi.logger
       }.compact
     end
 
-    def build_url(options)
-      api_section = options[:api_section]
-      version = options[:v] || DEFAULT_VERSION
-      method = options[:method]
-      format = options[:format] || DEFAULT_FORMAT
-      "#{API_HOST}/#{api_section}/#{version}/#{method}.#{format}"
+    def logger
+      MetricaApi.logger
+    end
+
+    def full_url
+      "#{base_url}?#{query}"
+    end
+
+    def query
+      params_with_token.map do |key, value|
+        [CGI.escape(key.to_s), '=', CGI.escape(value.to_s)]
+      end.map(&:join).join('&')
+    end
+
+    def params_with_token
+      @_params_with_token ||= params.merge(oauth_token: options.fetch(:oauth_token))
+    end
+
+    def base_url
+      @_base_url ||= begin
+        api_section = options[:api_section]
+        version = options[:v] || DEFAULT_VERSION
+        method = options[:method]
+        format = options[:format] || DEFAULT_FORMAT
+        "#{API_HOST}/#{api_section}/#{version}/#{method}.#{format}"
+      end
     end
 
   end

data/lib/metrica_api/response.rb

@@ -1,12 +1,10 @@
 # frozen_string_literal: true
 
-module MetricaApi
+class MetricaApi
   # Yandex Metrica response parser
-  module Response
+  class Response
 
-    module_function
-
-    def parse(response)
+    def self.parse(response)
       if response.is_a?(Array)
         response.map { |r| parse(r) }
       elsif response.is_a?(String)
@@ -18,9 +16,5 @@ module MetricaApi
       response
     end
 
-    def json_parse(response)
-      JSON.parse(response)
-    end
-
   end
 end

data/lib/metrica_api/sections/counters.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module MetricaApi
+class MetricaApi
   module Sections
     # Couters API
     class Counters

data/lib/metrica_api/sections/reporting.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module MetricaApi
+class MetricaApi
   module Sections
     # Reporting API
     class Reporting

data/lib/metrica_api/session.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module MetricaApi
+class MetricaApi
   # Metrica Api session object
   class Session
 

data/lib/metrica_api/version.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-module MetricaApi
+class MetricaApi
 
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 
 end

data/lib/metrica_api.rb

@@ -6,7 +6,7 @@ require 'metrica_api/sections/reporting'
 require 'metrica_api/sections/counters'
 
 # Yandex Metrica API module
-module MetricaApi
+class MetricaApi
 
   API_HOST = 'https://api-metrika.yandex.ru'
   DEFAULT_VERSION = 'v1'
@@ -16,37 +16,41 @@ module MetricaApi
   autoload :Request,  'metrica_api/request'
   autoload :Session,  'metrica_api/session'
 
-  autoload :ConnectionError,  'metrica_api/errors/connection_error'
-  autoload :RequestError,     'metrica_api/errors/request_error'
+  autoload :ConnectionError, 'metrica_api/errors/connection_error'
+  autoload :RequestError,    'metrica_api/errors/request_error'
 
-  autoload :Counters, 'metrica_api/sections/counters'
+  autoload :Counters,  'metrica_api/sections/counters'
   autoload :Reporting, 'metrica_api/sections/reporting'
 
-  mattr_accessor :logger
+  class << self
 
-  module_function
+    attr_accessor :logger
 
-  # @param options [Hash<:api_section, :method, :oauth_token[, :v[, :format]]>] navigation to method
-  # @param params [Hash] params for method
-  # @result [Hash] response as ruby plain object
-  def call(options, params)
-    response_parser.parse(request.make_request(options, params).to_s)
-  end
+    # @param options [Hash<:api_section, :method, :oauth_token[, :v[, :format]]>] navigation to method
+    # @param params [Hash] params for method
+    # @result [Hash] response as ruby plain object
+    def call(options, params)
+      response_parser.parse(request.call(options, params).to_s)
+    end
 
-  def counters(token)
-    Sections::Counters.new(token)
-  end
+    def counters(token)
+      Sections::Counters.new(token)
+    end
 
-  def reporting(token)
-    Sections::Reporting.new(token)
-  end
+    def reporting(token)
+      Sections::Reporting.new(token)
+    end
 
-  def response_parser
-    Response
-  end
+    def response_parser
+      Response
+    end
+
+    def request
+      Request
+    end
+
+    private
 
-  def request
-    Request
   end
 
 end

data/spec/request_spec.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require 'metrica_api'
+
+describe 'Requests' do
+  let(:access_token) { 'oauth_token' }
+
+  describe 'Counters' do
+    let(:api_object) { MetricaApi.counters(access_token) }
+
+    it 'performs GET-request' do
+      stub_request(
+        :get,
+        'https://api-metrika.yandex.ru/management/v1/counters.json?' +
+          'oauth_token=oauth_token&some_param=some_value'
+      ).to_return(body: '{"some_array": ["some", "items"], "some_number": 35}')
+
+      expect(api_object.data({ some_param: 'some_value' })).to(
+        eq("some_array" => ["some", "items"], "some_number" => 35)
+      )
+    end
+  end
+
+  describe 'Reporting' do
+    let(:api_object) { MetricaApi.reporting(access_token) }
+
+    it 'performs GET-request' do
+      stub_request(
+        :get,
+        'https://api-metrika.yandex.ru/stat/v1/data.json?' +
+          'oauth_token=oauth_token&some_param=some_value'
+      ).to_return(body: '{"some_array": ["some", "items"], "some_number": 35}')
+
+      expect(api_object.data({ some_param: 'some_value' })).to(
+        eq("some_array" => ["some", "items"], "some_number" => 35)
+      )
+    end
+  end
+
+  describe 'Logger' do
+    let(:logger) { double('Logger double', '<<': nil) }
+    before { MetricaApi.logger = logger }
+    after { MetricaApi.logger = nil }
+
+    it 'logs requests' do
+      stub_request(
+        :get,
+        'https://api-metrika.yandex.ru/stat/v1/data.json?' +
+          'oauth_token=oauth_token&some_param=some_value'
+      ).to_return(body: '{"some_array": ["some", "items"], "some_number": 35}')
+
+      expect(logger).to(
+        receive(:<<).with('https://api-metrika.yandex.ru/stat/v1/data.json?' +
+                            'some_param=some_value&oauth_token=oauth_token')
+      )
+      expect(logger).to(
+        receive(:<<).with('{"some_array": ["some", "items"], "some_number": 35}')
+      )
+
+      MetricaApi.reporting(access_token).data({ some_param: 'some_value' })
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'webmock/rspec'
+
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metrica_api
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - OneRetarget.com
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-19 00:00:00.000000000 Z
+date: 2018-10-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -161,6 +161,8 @@ files:
 - lib/metrica_api/session.rb
 - lib/metrica_api/version.rb
 - metrica_api.gemspec
+- spec/request_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/resivalex/metrica_api
 licenses:
 - MIT
@@ -185,4 +187,6 @@ rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Ruby client for Yandex Metrica API
-test_files: []
+test_files:
+- spec/request_spec.rb
+- spec/spec_helper.rb