direct-api-v5 0.0.1 → 0.1.0

data/spec/direct/api/v5/request_spec.rb

@@ -0,0 +1,60 @@
+require 'spec_helper'
+
+describe Direct::API::V5::Request do
+  let(:client) { make_direct_api_client }
+
+  describe '#send' do
+    let(:service) { :Campaigns }
+    let(:method) { :get }
+    let(:params) do
+      {
+        field_names: [:id, :name],
+        selection_criteria: { types: %w(TEXT_CAMPAIGN) }
+      }
+    end
+    let(:result) do
+      [
+        { Id: 1, Name: 'Campaign 1' },
+        { Id: 2, Name: 'Campaign 2' }
+      ]
+    end
+
+    let(:request_params) do
+      Direct::API::V5::ParamsBuilder.new(params).build
+    end
+    let(:request_body) do
+      { method: method, params: request_params }
+    end
+    let(:response_body) do
+      { result: { Campaigns: result } }
+    end
+
+    let(:request) do
+      described_class.new(
+        settings: client.settings,
+        service_name: service,
+        api_method: method,
+        params: params
+      )
+    end
+
+    context 'with valid response' do
+      before { stub_direct_api_request(service, request_body, response_body) }
+
+      it 'return body and headers' do
+        body, headers = request.send
+        expect(body).to eq(response_body)
+        expect(headers[:RequestId]).to eq(direct_api_request_id)
+        expect(headers[:Units]).to eq(direct_api_units)
+      end
+    end
+
+    context 'with invalid response' do
+      before { stub_direct_api_request(service, request_body, 'invalid') }
+
+      it 'raise error' do
+        expect { request.send }.to raise_error(Direct::API::V5::InvalidResponseError)
+      end
+    end
+  end
+end

data/spec/direct/api/v5/response/error_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+describe Direct::API::V5::Response::Error do
+  let(:data) do
+    {
+      error_code: 54,
+      error_string: 'No rights',
+      error_detail: 'No rights to indicated client'
+    }
+  end
+
+  subject { described_class.new(data) }
+
+  describe '#code' do
+    it { expect(subject.code).to eq(54) }
+  end
+
+  describe '#message' do
+    it { expect(subject.message).to eq('No rights') }
+  end
+
+  describe '#details' do
+    it { expect(subject.details).to eq('No rights to indicated client') }
+  end
+
+  describe '#to_h' do
+    error_hash = { code: 54, message: 'No rights', details: 'No rights to indicated client' }
+    it { expect(subject.to_h).to eq(error_hash) }
+  end
+end

data/spec/direct/api/v5/response/units_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+describe Direct::API::V5::Response::Units do
+  let(:raw_units) { '10/20828/64000' }
+
+  let(:units) { described_class.new(raw_units) }
+
+  describe '#raw' do
+    it { expect(units.raw).to eq(raw_units) }
+  end
+
+  describe '#spent' do
+    it { expect(units.spent).to eq(10) }
+  end
+
+  describe '#available' do
+    it { expect(units.available).to eq(20_828) }
+  end
+
+  describe '#daily_limit' do
+    it { expect(units.daily_limit).to eq(64_000) }
+  end
+
+  context 'with invalid data' do
+    let(:units) { described_class.new('invalid/data') }
+
+    it { expect(units.spent).to be_nil }
+    it { expect(units.available).to be_nil }
+    it { expect(units.daily_limit).to be_nil }
+  end
+end

data/spec/direct/api/v5/response_spec.rb

@@ -0,0 +1,66 @@
+require 'spec_helper'
+
+describe Direct::API::V5::Response do
+  let(:headers) do
+    {
+      RequestId: '123',
+      Units: '10/100/200'
+    }
+  end
+  let(:body) do
+    {
+      result: {
+        Campaigns: []
+      }
+    }
+  end
+  let(:error_body) do
+    {
+      error: {
+        error_code: 54,
+        error_string: 'No rights',
+        error_detail: 'No rights to indicated client'
+      }
+    }
+  end
+
+  let(:response) { described_class.new(body, headers) }
+  let(:error_response) { described_class.new(error_body, headers) }
+
+  describe '#result' do
+    it 'return data from result key' do
+      expect(response.result).to eq(Campaigns: [])
+      expect(error_response.result).to be_nil
+    end
+  end
+
+  describe '#request_id' do
+    it 'return data from headers' do
+      expect(response.request_id).to eq('123')
+      expect(error_response.request_id).to eq('123')
+    end
+  end
+
+  describe '#units' do
+    it 'return Units object' do
+      expect(response.units).to be_a(Direct::API::V5::Response::Units)
+      expect(response.units.raw).to eq('10/100/200')
+    end
+  end
+
+  describe '#error?' do
+    it 'check error key' do
+      expect(response.error?).to eq(false)
+      expect(error_response.error?).to eq(true)
+    end
+  end
+
+  describe '#error' do
+    it 'return Error object' do
+      expect(response.error).to be_nil
+
+      expect(error_response.error).to be_a(Direct::API::V5::Response::Error)
+      expect(error_response.error.code).to eq(54)
+    end
+  end
+end

data/spec/direct/api/v5/settings_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+describe Direct::API::V5::Settings do
+  describe '::new' do
+    let(:default_host) { 'default_host.com' }
+    let(:default_language) { 'en' }
+    let(:default_auth_token) { 'default_token' }
+    let(:default_client_login) { 'default_login' }
+
+    let(:host) { 'host.com' }
+    let(:language) { 'ru' }
+    let(:auth_token) { 'token' }
+    let(:client_login) { 'login' }
+
+    before do
+      allow(Direct::API::V5::DefaultSettings).to receive(:host).and_return(default_host)
+      allow(Direct::API::V5::DefaultSettings).to receive(:language).and_return(default_language)
+      allow(Direct::API::V5::DefaultSettings).to receive(:auth_token).and_return(default_auth_token)
+      allow(Direct::API::V5::DefaultSettings).to receive(:client_login).and_return(default_client_login)
+    end
+
+    context 'with params' do
+      subject do
+        described_class.new(host: host, language: language, auth_token: auth_token, client_login: client_login)
+      end
+
+      it { expect(subject.host).to eq(host) }
+      it { expect(subject.language).to eq(language) }
+      it { expect(subject.auth_token).to eq(auth_token) }
+      it { expect(subject.client_login).to eq(client_login) }
+    end
+
+    context 'without params' do
+      subject { described_class.new }
+
+      it { expect(subject.host).to eq(default_host) }
+      it { expect(subject.language).to eq(default_language) }
+      it { expect(subject.auth_token).to eq(default_auth_token) }
+      it { expect(subject.client_login).to eq(default_client_login) }
+    end
+  end
+end

data/spec/direct/api/v5_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+describe Direct::API::V5 do
+  describe '::client' do
+    let(:settings) { { param1: 'value1', param2: 'value2' } }
+    let(:client) { double('client') }
+
+    before { allow(described_class::Client).to receive(:new).with(settings).and_return(client) }
+
+    subject { described_class.client(settings) }
+
+    it 'create new client' do
+      is_expected.to eq(client)
+    end
+  end
+
+  describe '::load_settings' do
+    let(:yml_path) { 'file_path' }
+
+    it 'call DefaultSettings::load_from_yml' do
+      expect(described_class::DefaultSettings).to receive(:load_from_yml).with(yml_path)
+      described_class.load_settings(yml_path)
+    end
+  end
+
+  describe '::configure' do
+    # rubocop:disable Style/Proc
+    let(:proc) { Proc.new {} }
+
+    it 'call DefaultSettings::configure' do
+      expect(described_class::DefaultSettings).to receive(:configure) do |&block|
+        expect(proc).to be(block)
+      end
+      described_class.configure(&proc)
+    end
+  end
+end

data/spec/fixtures/settings.yml

@@ -0,0 +1,5 @@
+test:
+  host: api-sandbox.direct.yandex.com
+  language: ru
+  auth_token: token_string
+  client_login: login_string

data/spec/shared/direct_api_helper.rb

@@ -0,0 +1,66 @@
+require 'direct/api/v5'
+
+module DirectApiHelper
+  def make_direct_api_client
+    Direct::API::V5.client(
+      host: direct_api_host,
+      language: direct_api_language,
+      auth_token: direct_api_auth_token,
+      client_login: direct_api_client_login
+    )
+  end
+
+  def stub_direct_api_request(direct_service, request_body, response_body)
+    url = "https://#{direct_api_host}/json/v5/#{direct_service}/"
+    request_body = request_body.to_json if request_body.is_a?(Hash)
+    response_body = response_body.to_json if response_body.is_a?(Hash)
+    stub_request(:post, url)
+      .with(body: request_body, headers: direct_api_request_headers)
+      .to_return(body: response_body, headers: direct_api_response_headers)
+  end
+
+  def direct_api_request_headers
+    {
+      'Content-Type' => 'application/json; charset=utf-8',
+      'Accept-Language' => direct_api_language,
+      'Authorization' => "Bearer #{direct_api_auth_token}",
+      'Client-Login' => direct_api_client_login
+    }
+  end
+
+  def direct_api_response_headers
+    {
+      'Content-Type' => 'application/json',
+      'RequestId' => direct_api_request_id,
+      'Units' => direct_api_units
+    }
+  end
+
+  def direct_api_host
+    'api.direct.yandex.com'
+  end
+
+  def direct_api_language
+    'en'
+  end
+
+  def direct_api_auth_token
+    'token'
+  end
+
+  def direct_api_client_login
+    'client_id'
+  end
+
+  def direct_api_request_id
+    '8695244274068608439'
+  end
+
+  def direct_api_units
+    '10/20828/64000'
+  end
+end
+
+RSpec.configure do |config|
+  config.include DirectApiHelper
+end

data/spec/spec_helper.rb

@@ -0,0 +1,25 @@
+require 'codeclimate-test-reporter'
+CodeClimate::TestReporter.start
+
+ENV['RAILS_ENV'] ||= 'test'
+
+%w(support shared).each do |dir|
+  Dir[File.expand_path(File.join(File.dirname(__FILE__), dir, '**', '*.rb'))].each { |f| require f }
+end
+
+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.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  config.define_derived_metadata do |meta|
+    meta[:aggregate_failures] = true
+  end
+end

data/spec/support/webmock.rb

@@ -0,0 +1,3 @@
+require 'webmock/rspec'
+
+WebMock.disable_net_connect!(allow: 'codeclimate.com')

metadata

@@ -1,50 +1,123 @@
 --- !ruby/object:Gem::Specification
 name: direct-api-v5
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
-- Khrebtov Roman
+- Roman Khrebtov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-03 00:00:00.000000000 Z
+date: 2016-07-24 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '1.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '1.12'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.1'
+        version: '10.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.1'
-description: Ruby client for Yandex Direct API V5
+        version: '10.5'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ruby wrapper for Yandex Direct API V5
 email: roman@alltmb.ru
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
 - Gemfile
 - LICENSE
 - LICENSE.txt
@@ -52,7 +125,34 @@ files:
 - Rakefile
 - direct-api-v5.gemspec
 - lib/direct/api/v5.rb
+- lib/direct/api/v5/client.rb
+- lib/direct/api/v5/default_settings.rb
+- lib/direct/api/v5/errors.rb
+- lib/direct/api/v5/params_builder.rb
+- lib/direct/api/v5/refinements/camelize.rb
+- lib/direct/api/v5/request.rb
+- lib/direct/api/v5/response.rb
+- lib/direct/api/v5/response/error.rb
+- lib/direct/api/v5/response/units.rb
+- lib/direct/api/v5/service.rb
+- lib/direct/api/v5/settings.rb
 - lib/direct/api/v5/version.rb
+- spec/acceptance/error_spec.rb
+- spec/acceptance/get_campaigns_spec.rb
+- spec/direct/api/v5/client_spec.rb
+- spec/direct/api/v5/default_settings_spec.rb
+- spec/direct/api/v5/params_builder_spec.rb
+- spec/direct/api/v5/refinements/camelize_spec.rb
+- spec/direct/api/v5/request_spec.rb
+- spec/direct/api/v5/response/error_spec.rb
+- spec/direct/api/v5/response/units_spec.rb
+- spec/direct/api/v5/response_spec.rb
+- spec/direct/api/v5/settings_spec.rb
+- spec/direct/api/v5_spec.rb
+- spec/fixtures/settings.yml
+- spec/shared/direct_api_helper.rb
+- spec/spec_helper.rb
+- spec/support/webmock.rb
 homepage: https://github.com/Hrom512/direct-api-v5
 licenses:
 - MIT
@@ -65,7 +165,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.0'
+      version: '2.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -73,8 +173,24 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Yandex Direct API V5
-test_files: []
+test_files:
+- spec/acceptance/error_spec.rb
+- spec/acceptance/get_campaigns_spec.rb
+- spec/direct/api/v5/client_spec.rb
+- spec/direct/api/v5/default_settings_spec.rb
+- spec/direct/api/v5/params_builder_spec.rb
+- spec/direct/api/v5/refinements/camelize_spec.rb
+- spec/direct/api/v5/request_spec.rb
+- spec/direct/api/v5/response/error_spec.rb
+- spec/direct/api/v5/response/units_spec.rb
+- spec/direct/api/v5/response_spec.rb
+- spec/direct/api/v5/settings_spec.rb
+- spec/direct/api/v5_spec.rb
+- spec/fixtures/settings.yml
+- spec/shared/direct_api_helper.rb
+- spec/spec_helper.rb
+- spec/support/webmock.rb