metrica_api 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8c3c643b1ea64446fe23364c2a604315c42b955d
+  data.tar.gz: 5ba637f4d9e0f9a6cb3bfe2a6f0a033a9045e1af
+SHA512:
+  metadata.gz: db478488dc9de228d540d06bc557068d339a52380ff2e5add8d21eaf56a9fd1b80acaf37d05b52cde0c3ca058f29bc9655df5e267c410c81af055705659e8e0f
+  data.tar.gz: cc951ae6daa065a07fccbe0f47f7bf165e96fa6335f78b00bb5fe1656510123ec7909919223cc473748e3597d9279077a77113244a4939ea37af5c594a86d039

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in metrica_api.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,20 @@
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,49 @@
+# Ruby client for Yandex Metrica API
+
+[![Build Status](https://travis-ci.org/resivalex/metrica_api.svg?branch=master)](https://travis-ci.org/resivalex/metrica_api) [![Maintainability](https://api.codeclimate.com/v1/badges/7d22d20e04f9277afb35/maintainability)](https://codeclimate.com/github/resivalex/metrica_api/maintainability)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```
+gem 'metrica_api', '~> 0.0.1'
+```
+
+Or install from command line:
+
+```
+$ gem install metrica_api
+```
+
+## Usage
+
+```ruby
+# You need an access token to use API
+api = MetricaApi.counters(token)
+api.data(field: 'goals') # => { 'counters' => [...], ... }
+```
+
+## Exceptions
+
+```ruby
+def read_counters
+
+  MetricaApi.counters(token).data
+
+rescue MetricaApi::RequestError, MetricaApi::ConnectionError => e
+
+  puts e.message, e.backtrace
+
+end
+```
+
+## Testing
+
+```
+bundle exec rspec
+```
+
+## Contributing
+
+Create a pull-request or make an issue

data/lib/metrica_api/errors/connection_error.rb

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

data/lib/metrica_api/errors/request_error.rb

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

data/lib/metrica_api/request.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module MetricaApi
+  # Yandex Metrica request module
+  module Request
+
+    module_function
+
+    def make_request(options, params = {})
+
+      params[:oauth_token] = options.fetch(:oauth_token)
+      response = RestClient::Request.execute(build(options, params))
+      MetricaApi.logger << response if MetricaApi.logger
+      response
+    rescue RestClient::Unauthorized,
+           RestClient::Forbidden,
+           RestClient::BadRequest,
+           RestClient::ResourceNotFound => e
+      raise MetricaApi::RequestError,
+            "url: #{build_url(options)}?#{params.to_query}, original: #{e.message}"
+    rescue SocketError => e
+      raise MetricaApi::ConnectionError, e.message
+
+    end
+
+    def build(options, params)
+      params[:oauth_token] = options.fetch(:oauth_token)
+      {
+        method: :get,
+        url: build_url(options),
+        headers: { params: params },
+        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}"
+    end
+
+  end
+end

data/lib/metrica_api/response.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module MetricaApi
+  # Yandex Metrica response parser
+  module Response
+
+    module_function
+
+    def parse(response)
+      if response.is_a?(Array)
+        response.map { |r| parse(r) }
+      elsif response.is_a?(String)
+        JSON.parse(response)
+      else
+        response
+      end
+    rescue JSON::ParserError
+      response
+    end
+
+    def json_parse(response)
+      JSON.parse(response)
+    end
+
+  end
+end

data/lib/metrica_api/sections/counters.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module MetricaApi
+  module Sections
+    # Couters API
+    class Counters
+
+      def initialize(token)
+        @session = Session.new(token)
+      end
+
+      def data(params = {})
+        session.call({ api_section: 'management', method: 'counters' }, params)
+      end
+
+      private
+
+      attr_reader :session
+
+    end
+  end
+end

data/lib/metrica_api/sections/reporting.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module MetricaApi
+  module Sections
+    # Reporting API
+    class Reporting
+
+      def initialize(token)
+        @session = Session.new(token)
+      end
+
+      def data(params)
+        call('data', params)
+      end
+
+      def drilldown(params)
+        call('data/drilldown', params)
+      end
+
+      private
+
+      attr_reader :session
+
+      def call(method, params)
+        session.call({ api_section: 'stat', method: method }, params)
+      end
+
+    end
+  end
+end

data/lib/metrica_api/session.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module MetricaApi
+  # Metrica Api session object
+  class Session
+
+    def initialize(token)
+      @token = token
+    end
+
+    def call(options, params)
+      MetricaApi.call(options.merge(oauth_token: token), params)
+    end
+
+    private
+
+    attr_reader :token
+
+  end
+end

data/lib/metrica_api/version.rb

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

data/lib/metrica_api.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require 'restclient'
+require 'json'
+require 'metrica_api/sections/reporting'
+require 'metrica_api/sections/counters'
+
+# Yandex Metrica API module
+module MetricaApi
+
+  API_HOST = 'https://api-metrika.yandex.ru'
+  DEFAULT_VERSION = 'v1'
+  DEFAULT_FORMAT = 'json'
+
+  autoload :Response, 'metrica_api/response'
+  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 :Counters, 'metrica_api/sections/counters'
+  autoload :Reporting, 'metrica_api/sections/reporting'
+
+  mattr_accessor :logger
+
+  module_function
+
+  # @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
+
+  def counters(token)
+    Sections::Counters.new(token)
+  end
+
+  def reporting(token)
+    Sections::Reporting.new(token)
+  end
+
+  def response_parser
+    Response
+  end
+
+  def request
+    Request
+  end
+
+end

data/metrica_api.gemspec

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+# coding: utf-8
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'metrica_api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'metrica_api'
+  spec.version       = MetricaApi::VERSION
+  spec.authors       = ['OneRetarget.com']
+  spec.email         = ['help@oneretarget.com']
+  spec.summary       = 'Ruby client for Yandex Metrica API'
+  spec.description   = <<~DESC
+    Ruby client for Yandex Metrica API.
+    Make requests to counter and reporting sections of API.
+    OneRetarget.com - advertising automation service
+  DESC
+  spec.homepage      = 'https://github.com/resivalex/metrica_api'
+  spec.license       = 'MIT'
+
+  spec.files         = Dir['**/*']
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^spec/})
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'json', '~> 2.0', '>= 2.0.0'
+  spec.add_runtime_dependency 'rest-client', '~> 2.0', '>= 2.0.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rake', '~> 12.3.0', '>= 12.3.0'
+  spec.add_development_dependency 'rspec', '~> 3.7.0', '>= 3.7.0'
+  spec.add_development_dependency 'rubocop', '~> 0.54.0'
+  spec.add_development_dependency 'webmock', '~> 2.3.2', '>= 2.3.2'
+end

metadata

@@ -0,0 +1,188 @@
+--- !ruby/object:Gem::Specification
+name: metrica_api
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- OneRetarget.com
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-05-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 12.3.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 12.3.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.7.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.7.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.7.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.7.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.54.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.54.0
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.2
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.3.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.2
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.3.2
+description: |
+  Ruby client for Yandex Metrica API.
+  Make requests to counter and reporting sections of API.
+  OneRetarget.com - advertising automation service
+email:
+- help@oneretarget.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE.txt
+- README.md
+- lib/metrica_api.rb
+- lib/metrica_api/errors/connection_error.rb
+- lib/metrica_api/errors/request_error.rb
+- lib/metrica_api/request.rb
+- lib/metrica_api/response.rb
+- lib/metrica_api/sections/counters.rb
+- lib/metrica_api/sections/reporting.rb
+- lib/metrica_api/session.rb
+- lib/metrica_api/version.rb
+- metrica_api.gemspec
+homepage: https://github.com/resivalex/metrica_api
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: Ruby client for Yandex Metrica API
+test_files: []