direct-api-v5 0.0.1 → 0.1.0

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

@@ -0,0 +1,66 @@
+module Direct::API::V5
+  class Request
+    REQUEST_TIMEOUT = 300
+
+    def initialize(settings:, service_name:, api_method:, params: {})
+      @settings = settings
+      @service_name = service_name
+      @api_method = api_method
+      @params = params
+    end
+
+    def send
+      response = make_http_request
+      response_body = parse_response(response.body)
+
+      [response_body, response.headers]
+    end
+
+    private
+
+    def make_http_request
+      connection = Faraday.new(url: "https://#{api_host}")
+
+      connection.post do |request|
+        request.options.timeout = REQUEST_TIMEOUT
+        request.url api_url
+        request.body = body
+        headers.each do |key, value|
+          request.headers[key] = value
+        end
+      end
+    rescue Faraday::Error => e
+      raise RequestError, e.message
+    end
+
+    def parse_response(response_body)
+      MultiJson.load(response_body, symbolize_keys: true)
+    rescue MultiJson::ParseError => e
+      raise InvalidResponseError, e.message
+    end
+
+    def api_host
+      @settings.host
+    end
+
+    def api_url
+      "/json/v5/#{@service_name}/"
+    end
+
+    def headers
+      {
+        'Content-Type' => 'application/json; charset=utf-8',
+        'Accept-Language' => @settings.language,
+        'Authorization' => "Bearer #{@settings.auth_token}",
+        'Client-Login' => @settings.client_login
+      }
+    end
+
+    def body
+      MultiJson.dump(
+        method: @api_method,
+        params: ParamsBuilder.new(@params).build
+      )
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+module Direct::API::V5
+  class Response
+    attr_reader :body
+    attr_reader :headers
+
+    def initialize(body, headers)
+      @body = body
+      @headers = headers
+    end
+
+    def result
+      body[:result]
+    end
+
+    def request_id
+      @request_id ||= headers[:RequestId]
+    end
+
+    def units
+      @units ||= Units.new(headers[:Units])
+    end
+
+    def error?
+      body.key?(:error)
+    end
+
+    def error
+      return unless error?
+      @error ||= Error.new(body[:error])
+    end
+  end
+end

data/lib/direct/api/v5/response/error.rb

@@ -0,0 +1,21 @@
+module Direct::API::V5
+  class Response::Error
+    attr_reader :code
+    attr_reader :message
+    attr_reader :details
+
+    def initialize(error_data = {})
+      @code = error_data[:error_code]
+      @message = error_data[:error_string]
+      @details = error_data[:error_detail]
+    end
+
+    def to_h
+      {
+        code: code,
+        message: message,
+        details: details
+      }
+    end
+  end
+end

data/lib/direct/api/v5/response/units.rb

@@ -0,0 +1,34 @@
+module Direct::API::V5
+  class Response::Units
+    def initialize(raw_value)
+      @raw_value = raw_value
+    end
+
+    def raw
+      @raw_value
+    end
+
+    # Spent units (by request)
+    def spent
+      parts[0]
+    end
+
+    # Available units (in current hour)
+    def available
+      parts[1]
+    end
+
+    # Units daily limit
+    def daily_limit
+      parts[2]
+    end
+
+    private
+
+    def parts
+      @parts ||= @raw_value.to_s.strip.split('/').map do |part|
+        part =~ /^\d+$/ ? part.to_i : nil
+      end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+module Direct::API::V5
+  class Service
+    def initialize(client:, service_name:)
+      @client = client
+      @service_name = service_name
+    end
+
+    # Direct API methods
+    def method_missing(method, *args)
+      params = args[0] || {}
+      if params.is_a?(Hash)
+        call_api_method(method, params)
+      else
+        super
+      end
+    end
+
+    protected
+
+    def call_api_method(method_name, params = {})
+      request = Request.new(
+        settings: @client.settings,
+        service_name: @service_name,
+        api_method: method_name,
+        params: params
+      )
+      body, headers = request.send
+
+      Response.new(body, headers)
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+module Direct
+  module API
+    module V5
+      class Settings
+        attr_accessor :host
+        attr_accessor :language
+        attr_accessor :auth_token
+        attr_accessor :client_login
+
+        def initialize(settings = {})
+          @host = settings[:host] || DefaultSettings.host
+          @language = settings[:language] || DefaultSettings.language
+          @auth_token = settings[:auth_token] || DefaultSettings.auth_token
+          @client_login = settings[:client_login] || DefaultSettings.client_login
+        end
+      end
+    end
+  end
+end

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

@@ -1,7 +1,7 @@
 module Direct
   module API
     module V5
-      VERSION = '0.0.1'
+      VERSION = '0.1.0'.freeze
     end
   end
 end

data/spec/acceptance/error_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+
+describe 'api error', type: :acceptance do
+  let(:api) { make_direct_api_client }
+
+  before do
+    request_body = {
+      method: 'get',
+      params: {}
+    }
+
+    response_body = {
+      error: {
+        error_code: 54,
+        error_string: 'No rights',
+        error_detail: 'No rights to indicated client'
+      }
+    }
+
+    stub_direct_api_request(:campaigns, request_body, response_body)
+  end
+
+  subject(:response) { api.campaigns.get }
+
+  it 'return error' do
+    expect(response.error?).to be_truthy
+
+    expect(response.error.code).to eq(54)
+    expect(response.error.message).to eq('No rights')
+    expect(response.error.details).to eq('No rights to indicated client')
+  end
+end

data/spec/acceptance/get_campaigns_spec.rb

@@ -0,0 +1,72 @@
+require 'spec_helper'
+
+describe 'campaigns.get', type: :acceptance do
+  let(:api) { make_direct_api_client }
+
+  before do
+    request_body = {
+      method: 'get',
+      params: {
+        FieldNames: %w(Id Name State StartDate),
+        TextCampaignFieldNames: %w(CounterIds RelevantKeywords),
+        SelectionCriteria: {
+          Types: %w(TEXT_CAMPAIGN),
+          States: %w(ON SUSPENDED),
+          StatusesPayment: %w(ALLOWED)
+        }
+      }
+    }
+
+    response_body = {
+      result: {
+        Campaigns: [
+          { Id: 1, Name: 'Campaign 1', State: 'ON', StartDate: '2016-01-01' },
+          { Id: 2, Name: 'Campaign 2', State: 'SUSPENDED', StartDate: '2016-02-01' }
+        ]
+      }
+    }
+
+    stub_direct_api_request(:campaigns, request_body, response_body)
+  end
+
+  subject(:response) do
+    api.campaigns.get(
+      fields: [:id, :name, :state, :start_date],
+      text_campaign_fields: [:counter_ids, :relevant_keywords],
+      criteria: { types: %w(TEXT_CAMPAIGN), states: %w(ON SUSPENDED), statuses_payment: %w(ALLOWED) }
+    )
+  end
+
+  let(:campaigns) { response.result[:Campaigns] }
+  let(:campaign) { campaigns[0] }
+
+  it 'is not error' do
+    expect(response.error?).to be_falsey
+  end
+
+  it 'have request_id' do
+    expect(response.request_id).to eq(direct_api_request_id)
+  end
+
+  it 'have units' do
+    expect(response.units.raw).to eq(direct_api_units) # '10/20828/64000'
+
+    expect(response.units.spent).to eq(10)
+    expect(response.units.available).to eq(20_828)
+    expect(response.units.daily_limit).to eq(64_000)
+  end
+
+  it 'have campaigns' do
+    expect(campaigns.size).to eq(2)
+  end
+
+  it 'campaign contains data' do
+    expected = {
+      Id: 1,
+      Name: 'Campaign 1',
+      State: 'ON',
+      StartDate: '2016-01-01'
+    }
+    expect(campaign).to eq(expected)
+  end
+end

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

@@ -0,0 +1,28 @@
+require 'spec_helper'
+
+describe Direct::API::V5::Client do
+  let(:client) { described_class.new }
+
+  describe '::new' do
+    let(:settings) { { param1: 'value1', param2: 'value2' } }
+    let(:settings_obj) { double('settings') }
+
+    subject { described_class.new(settings) }
+
+    it 'create Settings object' do
+      allow(Direct::API::V5::Settings).to receive(:new).with(settings).and_return(settings_obj)
+      expect(subject.settings).to eq(settings_obj)
+    end
+  end
+
+  describe '#service_name' do
+    let(:service_obj) { double('service_obj') }
+
+    it 'return service object' do
+      params = { client: client, service_name: :campaigns }
+      allow(Direct::API::V5::Service).to receive(:new).with(params).and_return(service_obj)
+
+      expect(client.campaigns).to eq(service_obj)
+    end
+  end
+end

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

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+describe Direct::API::V5::DefaultSettings do
+  describe 'default values' do
+    it { expect(described_class.host).to eq('api.direct.yandex.com') }
+    it { expect(described_class.language).to eq('en') }
+    it { expect(described_class.auth_token).to be_nil }
+    it { expect(described_class.client_login).to be_nil }
+  end
+
+  describe '::load_from_yml' do
+    let(:path) { File.join(File.dirname(__FILE__), '../../../fixtures/settings.yml') }
+
+    before { described_class.load_from_yml(path) }
+
+    it { expect(described_class.host).to eq('api-sandbox.direct.yandex.com') }
+    it { expect(described_class.language).to eq('ru') }
+    it { expect(described_class.auth_token).to eq('token_string') }
+    it { expect(described_class.client_login).to eq('login_string') }
+  end
+
+  describe '::configure' do
+    let(:host) { 'new_host.direct.yandex.com' }
+    let(:language) { 'uk' }
+    let(:auth_token) { 'custom_token' }
+    let(:client_login) { 'custom_client' }
+
+    before do
+      described_class.configure do |conf|
+        conf.host = host
+        conf.auth_token = auth_token
+        conf.client_login = client_login
+        conf.language = language
+      end
+    end
+
+    it { expect(described_class.host).to eq(host) }
+    it { expect(described_class.language).to eq(language) }
+    it { expect(described_class.auth_token).to eq(auth_token) }
+    it { expect(described_class.client_login).to eq(client_login) }
+  end
+end

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

@@ -0,0 +1,39 @@
+require 'spec_helper'
+
+describe Direct::API::V5::ParamsBuilder do
+  let(:input_params) do
+    {
+      criteria: {
+        types: %w(TEXT_CAMPAIGN),
+        states: %w(ON OFF)
+      },
+      fields: [:id, :name, :state, :status, :status_payment],
+      text_campaign_fields: [:counter_ids],
+      page: {
+        limit: 100,
+        offset: 200
+      }
+    }
+  end
+
+  let(:output_params) do
+    {
+      SelectionCriteria: {
+        Types: %w(TEXT_CAMPAIGN),
+        States: %w(ON OFF)
+      },
+      FieldNames: [:Id, :Name, :State, :Status, :StatusPayment],
+      TextCampaignFieldNames: [:CounterIds],
+      Page: {
+        Limit: 100,
+        Offset: 200
+      }
+    }
+  end
+
+  subject { described_class.new(input_params).build }
+
+  it 'prepare params' do
+    is_expected.to eq(output_params)
+  end
+end

data/spec/direct/api/v5/refinements/camelize_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+describe Direct::API::V5::Refinements::Camelize do
+  using described_class
+
+  describe 'String#camelize' do
+    it 'camelize string' do
+      expect('consider_working_weekends'.camelize).to eq('ConsiderWorkingWeekends')
+    end
+
+    it 'return self if already camelized' do
+      expect('ConsiderWorkingWeekends'.camelize).to eq('ConsiderWorkingWeekends')
+    end
+  end
+
+  describe 'Symbol#camelize' do
+    it 'camelize symbol' do
+      expect(:consider_working_weekends.camelize).to eq(:ConsiderWorkingWeekends)
+    end
+  end
+end