direct-api-v5 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bbdcb212c1664f42f2fb8a647eaa5331c5eab341
-  data.tar.gz: 3e2c3b16e9003da6a36d24ba36b33c40a7f29492
+  metadata.gz: e0b7ada51310f1611e7cd6c4b0b1ac4e7b85d216
+  data.tar.gz: 0aa5fe6526f859074b69aee22679337c8e5a7f3d
 SHA512:
-  metadata.gz: 577c0ee649f3508d3a39682f3de3a712953c262d3fe9e54b7a542d7a57a961b300502a74ef20ba417bc3e66ff1d43387e1802e8706bb853fe9804f8d2398468c
-  data.tar.gz: ece1ac9ef9c62549bf72e7d818172f49b3606813c02416a5180405a92511960d814336754bed484f5c099a52eb5eb9bca1e2a9e816726c3a59e5a02aa210e99d
+  metadata.gz: 6713261cb4abccccc582f94b834e12cb4f95434b125b57dc4e771bd6e3553d53c47fdf750b9570888b9260f103eb0b75efc0dcc04d59d2138b5e28b1a8c7998d
+  data.tar.gz: c9cf7c9c34511c8ee0906affbdd5e47c0f5b2bf0e785417f350761a49f4d8fac92342e2664419b76ef671a8e859688191d264beba405123f6c14001795338811

data/.gitignore

@@ -20,4 +20,5 @@ tmp
 *.o
 *.a
 mkmf.log
-.idea/*
+.ruby-gemset
+.ruby-version

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,19 @@
+AllCops:
+  DisplayCopNames: true
+  DisplayStyleGuide: true
+
+Metrics/LineLength:
+  Max: 120
+
+Metrics/MethodLength:
+  Max: 15
+
+Style/BlockComments:
+  Exclude:
+    - 'spec/spec_helper.rb'
+
+Style/Documentation:
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,17 @@
+language: ruby
+script:
+  - bundle exec rspec
+rvm:
+  - 2.1.8
+  - 2.2.4
+  - 2.3.0
+notifications:
+  webhooks:
+    urls:
+      - https://webhooks.gitter.im/e/d9db7a73fbd8f58f1432
+    on_success: change  # options: [always|never|change] default: always
+    on_failure: always  # options: [always|never|change] default: always
+    on_start: never     # options: [always|never|change] default: always
+addons:
+  code_climate:
+    repo_token: 69b68e6f16334696d97d7171ead60f33ab98eb50026a92bde56963f7722492f8

data/Gemfile

@@ -1,3 +1,5 @@
 source 'https://rubygems.org'
 
 gemspec
+
+gem 'codeclimate-test-reporter', group: :test, require: nil

data/README.md

@@ -1,6 +1,13 @@
 # Direct::API::V5
 
-TODO: Write a gem description
+[![Gem Version](https://badge.fury.io/rb/direct-api-v5.svg)](https://badge.fury.io/rb/direct-api-v5)
+[![Travis CI](https://travis-ci.org/hrom512/direct-api-v5.svg?branch=dev)](https://travis-ci.org/hrom512/direct-api-v5)
+[![Code Climate](https://codeclimate.com/github/Hrom512/direct-api-v5/badges/gpa.svg)](https://codeclimate.com/github/Hrom512/direct-api-v5)
+[![Test Coverage](https://codeclimate.com/github/Hrom512/direct-api-v5/badges/coverage.svg)](https://codeclimate.com/github/Hrom512/direct-api-v5/coverage)
+[![Dependency Status](https://gemnasium.com/hrom512/direct-api-v5.svg)](https://gemnasium.com/hrom512/direct-api-v5)
+
+Ruby wrapper for Yandex Direct API V5.
+
 
 ## Installation
 
@@ -16,13 +23,130 @@ Or install it yourself as:
 
     $ gem install direct-api-v5
 
+
 ## Usage
 
-TODO: Write usage instructions here
+### Settings
+
+1. Load settings from YML file
+
+  ```ruby
+  Direct::API::V5.load_settings('config/yandex_direct_api.yml')
+  ```
+
+  ```yml
+  production:
+    host: api.direct.yandex.com
+    auth_token: token_string
+    client_login: login_string
+
+  development:
+    host: api-sandbox.direct.yandex.com
+    auth_token: token_string
+    client_login: login_string
+  ```
+
+2. Configure in block
+
+  ```ruby
+  Direct::API::V5.configure do |config|
+    config.host = 'api.direct.yandex.com'
+    config.auth_token = 'token_string'
+    config.client_login = 'login_string'
+  end
+  ```
+
+### Create client
+
+```ruby
+api = Direct::API::V5.client
+```
+
+You can set client login (if advertising agency)
+
+```ruby
+api = Direct::API::V5.client(client_login: 'login_string')
+```
+
+Also you can overwrite any default settings:
+
+```ruby
+api = Direct::API::V5.client(host: 'api.direct.yandex.com', auth_token: 'token')
+```
+
+### Call methods
+
+Base structure:
+
+```ruby
+api.service_name.method(params)
+```
+
+For example:
+
+```ruby
+response = api.campaigns.get(
+  fields: [:id, :name],
+  criteria: { states: %(ON) },
+  page: { limit: 100, offset: 200 }
+)
+
+response.error?
+# => false
+
+response.result
+# =>
+# {
+#   Campaigns: [
+#     { Id: 1, Name: "Campaign 1" },
+#     ...
+#   ]
+# }
+
+response.request_id
+# => 123456
+
+response.units.spent
+# => 10
+
+response.units.available
+# => 1000
+
+response.units.daily_limit
+# => 2000
+
+response.units.raw
+# => 10/1000/2000
+```
+
+If API return error:
+
+```ruby
+response.error?
+# => true
+
+response.error.code
+# => 54
+
+response.error.message
+# => "No rights"
+
+response.error.details
+# => "No rights to indicated client"
+
+response.error.to_h
+# =>
+# {
+#   code: 54,
+#   message: "No rights",
+#   details: "No rights to indicated client"
+# }
+```
+
 
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/direct-api-v5/fork )
+1. Fork it ( https://github.com/hrom512/direct-api-v5/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

data/direct-api-v5.gemspec

@@ -6,10 +6,10 @@ require 'direct/api/v5/version'
 Gem::Specification.new do |spec|
   spec.name          = 'direct-api-v5'
   spec.version       = Direct::API::V5::VERSION
-  spec.author        = 'Khrebtov Roman'
+  spec.author        = 'Roman Khrebtov'
   spec.email         = 'roman@alltmb.ru'
   spec.summary       = 'Yandex Direct API V5'
-  spec.description   = 'Ruby client for Yandex Direct API V5'
+  spec.description   = 'Ruby wrapper for Yandex Direct API V5'
   spec.homepage      = 'https://github.com/Hrom512/direct-api-v5'
   spec.license       = 'MIT'
 
@@ -18,8 +18,14 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.required_ruby_version = '>= 2.0'
+  spec.required_ruby_version = '>= 2.1'
 
-  spec.add_development_dependency 'bundler', '~> 1.6'
-  spec.add_development_dependency 'rake', '~> 10.1'
+  spec.add_dependency 'faraday', '~> 0.9'
+  spec.add_dependency 'multi_json', '~> 1.12'
+
+  spec.add_development_dependency 'bundler', '~> 1.12'
+  spec.add_development_dependency 'rake', '~> 10.5'
+  spec.add_development_dependency 'rspec', '~> 3.5'
+  spec.add_development_dependency 'webmock', '~> 2.1'
+  spec.add_development_dependency 'rubocop'
 end

data/lib/direct/api/v5.rb

@@ -1,8 +1,53 @@
+require 'faraday'
+require 'multi_json'
+
 require 'direct/api/v5/version'
+require 'direct/api/v5/errors'
+require 'direct/api/v5/refinements/camelize'
+require 'direct/api/v5/default_settings'
+require 'direct/api/v5/settings'
+require 'direct/api/v5/client'
+require 'direct/api/v5/service'
+require 'direct/api/v5/request'
+require 'direct/api/v5/params_builder'
+require 'direct/api/v5/response'
+require 'direct/api/v5/response/error'
+require 'direct/api/v5/response/units'
+
+module Direct::API::V5
+  class << self
+    # Create API client
+    # @param settings [Hash] API settings (:host, :auth_token, :client_login)
+    # @return [Direct::API::V5::Client] new client object
+    #
+    # @example Without settings
+    #   client = Direct::API::V5.client
+    #
+    # @example With settings
+    #   client = Direct::API::V5.client(host: 'api.direct.yandex.com',
+    #                                   auth_token: 'token',
+    #                                   client_login: 'login')
+    def client(settings = {})
+      Client.new(settings)
+    end
+
+    # Set default settings from block
+    # @example
+    #   Direct::API::V5.configure do |config|
+    #     config.host = 'api.direct.yandex.com'
+    #     config.auth_token = 'token'
+    #     config.client_login = 'login'
+    #   end
+    def configure(&block)
+      DefaultSettings.configure(&block)
+    end
 
-module Direct
-  module API
-    module V5
+    # Set default settings from .yml file
+    # @param yml_file [String] path to .yml file
+    # @example
+    #   Direct::API::V5.load_settings('config/yandex_direct_api.yml')
+    def load_settings(yml_file)
+      DefaultSettings.load_from_yml(yml_file)
     end
   end
 end

data/lib/direct/api/v5/client.rb

@@ -0,0 +1,18 @@
+module Direct::API::V5
+  class Client
+    attr_reader :settings
+
+    def initialize(settings = {})
+      @settings = Settings.new(settings)
+    end
+
+    # Direct services methods
+    def method_missing(method, *args)
+      if args.empty?
+        Service.new(client: self, service_name: method)
+      else
+        super
+      end
+    end
+  end
+end

data/lib/direct/api/v5/default_settings.rb

@@ -0,0 +1,42 @@
+module Direct
+  module API
+    module V5
+      # Default API settings store
+      class DefaultSettings
+        class << self
+          DEFAULT_HOST = 'api.direct.yandex.com'.freeze
+          DEFAULT_LANGUAGE = 'en'.freeze
+
+          attr_accessor :host
+          attr_accessor :language
+          attr_accessor :auth_token
+          attr_accessor :client_login
+
+          # Return configured host or default value
+          def host
+            @host || DEFAULT_HOST
+          end
+
+          # Return configured language or default value
+          def language
+            @language || DEFAULT_LANGUAGE
+          end
+
+          # Set default settings from .yml file
+          def load_from_yml(yml_file)
+            settings = YAML.load_file(yml_file)[ENV['RAILS_ENV']] || {}
+            @host = settings['host']
+            @language = settings['language']
+            @auth_token = settings['auth_token']
+            @client_login = settings['client_login']
+          end
+
+          # Set default settings from block
+          def configure
+            yield(self)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/direct/api/v5/errors.rb

@@ -0,0 +1,10 @@
+module Direct::API::V5
+  class Error < StandardError
+  end
+
+  class RequestError < Error
+  end
+
+  class InvalidResponseError < Error
+  end
+end

data/lib/direct/api/v5/params_builder.rb

@@ -0,0 +1,46 @@
+module Direct::API::V5
+  class ParamsBuilder
+    using Refinements::Camelize
+
+    def initialize(params = {})
+      @params = params
+    end
+
+    def build
+      process_value(@params)
+    end
+
+    private
+
+    def process_value(value)
+      if value.is_a?(Hash)
+        process_hash(value)
+      elsif value.is_a?(Array)
+        process_array(value)
+      elsif value.is_a?(Symbol)
+        value.camelize
+      else
+        value
+      end
+    end
+
+    def process_hash(hash)
+      result = {}
+
+      hash.each do |key, value|
+        key = :selection_criteria if key == :criteria
+        key = "#{key.to_s[0..-7]}field_names".to_sym if key.to_s.end_with?('fields')
+
+        new_key = process_value(key)
+        new_value = process_value(value)
+        result[new_key] = new_value
+      end
+
+      result
+    end
+
+    def process_array(array)
+      array.map { |item| process_value(item) }
+    end
+  end
+end

data/lib/direct/api/v5/refinements/camelize.rb

@@ -0,0 +1,22 @@
+module Direct::API::V5
+  module Refinements
+    # Add camelize method to String and Symbol
+    module Camelize
+      refine String do
+        def camelize
+          if self =~ /[A-Z]/
+            self
+          else
+            split('_').map(&:capitalize).join('')
+          end
+        end
+      end
+
+      refine Symbol do
+        def camelize
+          to_s.camelize.to_sym
+        end
+      end
+    end
+  end
+end