hasoffersv3 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 537eb480dbf6608cf635d04031adbf6d6c33a6d7
-  data.tar.gz: 57ee201a3270c904e2660e8bc01e8a4f9afc20ba
+  metadata.gz: d6d4931962a54c3bf75cc4169d8655914a15545c
+  data.tar.gz: f780dbccf7809ffa58f85c71a86b48c9061d185f
 SHA512:
-  metadata.gz: a861581ccb305f93dd235c44778edca934f1166299e6d1d9caf907cb1d47de51af19490453f28e15fe334047872078285e658bf601dcefa5dd273c5cbc79c088
-  data.tar.gz: 2f447bc955d8f3b2a02e06a45bcc7739f39abe2be711d0cd7f25b046e12fab673ae4bb0a5d50db2dd424b528ca17ec847e73efd49b20d1f05df64001ae50e9a2
+  metadata.gz: c65325e39ed7c68f52e94b657f0626723921c7927be29a4da35e0d208d1f8cb56f3cb0212c32ef16baddbb9947d21b4f7dfd672fd96b464a39ebd817d65e00b4
+  data.tar.gz: cdd6b8143f3c9b0895a93c7042a65f4cbf0aea5240413a9b5a69ef22c3a161254e567436d55be75695622891d1473bc39449b2d32961682d3cd9c5c17804190b

data/.rspec

@@ -1,2 +1,3 @@
 --color
 --format documentation
+--require=spec_helper

data/.travis.yml

@@ -3,9 +3,6 @@ script: bundle exec rspec spec
 before_install:
   - gem install bundler
 rvm:
-  - 1.9.3
-  - 2.0.0
-  - 2.1.8
-  - 2.2.4
-  - 2.3.0
+  - 2.2.5
+  - 2.3.1
   - ruby-head

data/README.md

@@ -1,4 +1,4 @@
-### Overview 
+### Overview
 
 [![Build status](https://api.travis-ci.org/applift/hasoffersv3.png?branch=master)](http://travis-ci.org/applift/hasoffersv3)
 
@@ -10,10 +10,8 @@ This gem provides a wrapper around HasOffers API in version 3, [HasOffers APIv3
 
 Supported ruby versions:
 
-*   1.9.3
-*   2.0
-*   2.1
 *   2.2
+*   2.3
 
 ## Installation
 
@@ -70,6 +68,20 @@ HasOffersV3::Advertiser.signup({
 })
 ```
 
+### Logging
+
+To enable log you can set a logger in configuration. All HTTP requests and responses will be logged.
+
+To disable it, just set the logger configuration to `nil` value. Default is disabled.
+
+An example setting Rails logger:
+
+```ruby
+HasOffersV3.configure do |config|
+  config.logger = Rails.logger
+end
+```
+
 ## Testing
 
 If `RAILS_ENV` or `RACK_ENV` is set to `test`, or there's a `TEST`

data/hasoffersv3.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |s|
 
   s.add_dependency 'activesupport' # for to_param method
   s.add_development_dependency 'webmock'
-  s.add_development_dependency 'rspec',   '~> 3.0.0'
+  s.add_development_dependency 'rspec',   '~> 3.4.0'
   s.add_development_dependency 'bundler', '~> 1.3'
   s.add_development_dependency 'rake'
 end

data/lib/hasoffersv3/affiliate_offer.rb

@@ -17,21 +17,45 @@ class HasOffersV3
       post_request 'findById', params
     end
 
+    def get_approval_questions(params = {})
+      requires! params, [:offer_id]
+      get_request 'getApprovalQuestions', params
+    end
+
     def get_categories(params = {})
       requires! params, [:ids]
       post_request 'getCategories', params
     end
 
+    def get_payout_details(params = {})
+      requires! params, [:offer_id]
+      get_request 'getPayoutDetails', params
+    end
+
+    def get_pixels(params = {})
+      requires! params, [:id]
+      get_request 'getPixels', params
+    end
+
     def get_target_countries(params = {})
       requires! params, [:ids]
       post_request 'getTargetCountries', params
     end
 
+    def get_thumbnail(params = {})
+      requires! params, [:ids]
+      get_request 'getThumbnail', params
+    end
+
     def generate_tracking_link(params = {})
       requires! params, [:offer_id]
       post_request 'generateTrackingLink', params
     end
 
+    def find_my_approved_offers(params = {})
+      get_request 'findMyApprovedOffers', params
+    end
+
     def find_my_offers(params = {})
       post_request 'findMyOffers', params
     end

data/lib/hasoffersv3/client.rb

@@ -25,8 +25,13 @@ class HasOffersV3
         http              = new_http(uri)
         raw_request       = Net::HTTP::Get.new(uri.request_uri)
       end
+
+      logger.log_request(raw_request, uri)
+
       http_response = execute_request(http, raw_request)
 
+      logger.log_response(http_response)
+
       Response.new(http_response, @configuration.json_driver)
     end
 
@@ -60,5 +65,11 @@ class HasOffersV3
       configuration.base_uri
     end
 
+    private
+
+    def logger
+      configuration.http_logger
+    end
+
   end
 end

data/lib/hasoffersv3/configuration.rb

@@ -19,7 +19,8 @@ class HasOffersV3
       base_path: '/v3',
       network_id: '',
       api_key: '',
-      json_driver: self.default_json_driver
+      json_driver: self.default_json_driver,
+      logger: nil
     }.freeze
 
     DEFAULTS.keys.each do |option_name|
@@ -49,6 +50,10 @@ class HasOffersV3
       end
     end
 
+    def http_logger
+      @http_logger ||= HasOffersV3::Logger.new(logger)
+    end
+
     def base_uri
       "#{protocol}://#{host}#{base_path}"
     end

data/lib/hasoffersv3/logger.rb

@@ -0,0 +1,45 @@
+class HasOffersV3
+  class Logger
+    LABEL = '[HasOffersV3]'.freeze
+
+    attr_reader :log
+
+    def initialize(log = nil)
+      @log = log
+    end
+
+    def log_request(request, uri)
+      log_http(request, "Request: #{request.method} #{uri}")
+    end
+
+    def log_response(response)
+      log_http(response, "Response: HTTP/#{response.http_version} #{response.code} #{response.message}")
+    end
+
+    private
+
+    def log_http(http, first_line)
+      return unless log
+
+      message = format_message(http, first_line)
+      log.info(message)
+    end
+
+    def format_message(http, first_line)
+      StringIO.open do |s|
+        s.puts("#{LABEL} #{first_line}")
+        append_headers(s, http.each_capitalized)
+        s.puts(http.body) unless http.body.to_s.empty?
+        s.string
+      end
+    end
+
+    def append_headers(message, headers)
+      headers.each do |name, value|
+        message.puts("#{name}: #{value}")
+      end
+
+      message.puts
+    end
+  end
+end

data/lib/hasoffersv3/report.rb

@@ -9,5 +9,9 @@ class HasOffersV3
     def get_mod_summary_logs(params = {}, &block)
       get_request 'getModSummaryLogs', params, &block
     end
+
+    def get_stats(params = {}, &block)
+      post_request 'getStats', params, &block
+    end
   end
 end

data/lib/hasoffersv3/version.rb

@@ -1,3 +1,3 @@
 class HasOffersV3
-  VERSION = '0.4.1'
+  VERSION = '0.5.0'
 end

data/lib/hasoffersv3.rb

@@ -3,7 +3,7 @@ require 'json'
 
 require 'hasoffersv3/client'
 
-%w!base affiliate response conversion raw_log report configuration advertiser advertiser_user offer offer_pixel employee application!.each do |file|
+%w!base affiliate response conversion raw_log report configuration advertiser advertiser_user offer offer_pixel employee application logger!.each do |file|
   require "hasoffersv3/#{file}"
 end
 

data/spec/lib/advertiser_billing_spec.rb

@@ -1,11 +1,7 @@
-require 'spec_helper'
-
 describe HasOffersV3::AdvertiserBilling do
-  subject { HasOffersV3::AdvertiserBilling }
-
   let(:url) { api_url 'AdvertiserBilling' }
 
-  describe '.find_all_invoices' do
+  describe '#find_all_invoices' do
     it 'makes a proper request call' do
       stub_call
       response = subject.find_all_invoices
@@ -14,7 +10,7 @@ describe HasOffersV3::AdvertiserBilling do
     end
   end
 
-  describe '.create_invoice' do
+  describe '#create_invoice' do
     context 'when data is specified' do
       it 'makes a proper request call' do
         stub_call
@@ -35,7 +31,7 @@ describe HasOffersV3::AdvertiserBilling do
     end
   end
 
-  describe '.find_invoice_by_id' do
+  describe '#find_invoice_by_id' do
     context 'when ID is specified' do
       it 'makes a proper request call' do
         stub_call
@@ -52,16 +48,16 @@ describe HasOffersV3::AdvertiserBilling do
     end
   end
 
-  describe '.add_invoice_item' do
+  describe '#add_invoice_item' do
     context 'when invoice  ID and data is specified' do
       it 'makes a proper request call' do
         stub_call
         response = subject.add_invoice_item(invoice_id: 1, data: {memo: 'abc'})
-        a_request(:post, url).with(body: hash_including({
+        expect(a_request(:post, url).with(body: hash_including({
           'Method'     => 'addInvoiceItem',
           'invoice_id' => '1',
           'data'       => {'memo' => 'abc'}
-        })).should have_been_made
+        }))).to have_been_made
         validate_call response
       end
     end
@@ -79,12 +75,12 @@ describe HasOffersV3::AdvertiserBilling do
     end
   end
 
-  describe '.remove_invoice_item' do
+  describe '#remove_invoice_item' do
     context 'when ID is specified' do
       it 'makes a proper request call' do
         stub_call
         response = subject.remove_invoice_item(id: '1')
-        a_request(:post, url).with(body: hash_including({'Method' => 'removeInvoiceItem', 'id' => '1'})).should have_been_made
+        expect(a_request(:post, url).with(body: hash_including({'Method' => 'removeInvoiceItem', 'id' => '1'}))).to have_been_made
         validate_call response
       end
     end

data/spec/lib/advertiser_spec.rb

@@ -1,12 +1,8 @@
-require 'spec_helper'
-
 describe HasOffersV3::Advertiser do
-  subject { HasOffersV3::Advertiser.new }
-
   let(:url)  { api_url 'Advertiser' }
 
-  describe '.find_all' do
-    it 'should make a proper request call' do
+  describe '#find_all' do
+    it 'makes a proper request call' do
       stub_call
       response = subject.find_all
       expect(a_request(:post, url).with(body: hash_including({'Method' => 'findAll'}))).to have_been_made
@@ -14,8 +10,8 @@ describe HasOffersV3::Advertiser do
     end
   end
 
-  describe '.find_all_ids' do
-    it 'should make a proper request call' do
+  describe '#find_all_ids' do
+    it 'makes a proper request call' do
       stub_call
       response = subject.find_all_ids
       expect(a_request(:post, url).with(body: hash_including({'Method' => 'findAllIds'}))).to have_been_made
@@ -23,8 +19,8 @@ describe HasOffersV3::Advertiser do
     end
   end
 
-  describe '.find_by_id' do
-    it 'should make a proper request call' do
+  describe '#find_by_id' do
+    it 'makes a proper request call' do
       stub_call
       response = subject.find_by_id id: 1
       expect(a_request(:post, url).with(body: hash_including({'Method' => 'findById', 'id' => '1'}))).to have_been_made
@@ -32,7 +28,7 @@ describe HasOffersV3::Advertiser do
     end
 
     context 'when there is no id' do
-      it 'should raise exception' do
+      it 'raises exception' do
         expect { subject.find_by_id failed_id: 1 }.to raise_error ArgumentError
       end
     end

data/spec/lib/advertiser_user_spec.rb

@@ -1,12 +1,8 @@
-require 'spec_helper'
-
 describe HasOffersV3::AdvertiserUser do
-  subject { HasOffersV3::AdvertiserUser.new }
-
   let(:url)  { api_url 'AdvertiserUser' }
 
-  describe '.find_all' do
-    it 'should make a proper request call' do
+  describe '#find_all' do
+    it 'makes a proper request call' do
       stub_call
       response = subject.find_all
       expect(a_request(:post, url).with(body: hash_including({'Method' => 'findAll'}))).to have_been_made

data/spec/lib/affiliate_billing_spec.rb

@@ -1,16 +1,12 @@
-require 'spec_helper'
-
 describe HasOffersV3::AffiliateBilling do
-  subject { HasOffersV3::AffiliateBilling.new }
-
   let(:url) { api_url 'AffiliateBilling' }
 
-  describe '.find_last_invoice' do
+  describe '#find_last_invoice' do
     context 'when affiliate ID is specified' do
       it 'makes a proper request call' do
         stub_call
         response = subject.find_last_invoice(affiliate_id: '1')
-        a_request(:post, url).with(body: hash_including({'Method' => 'findLastInvoice', 'affiliate_id' => '1'})).should have_been_made
+        expect(a_request(:post, url).with(body: hash_including({'Method' => 'findLastInvoice', 'affiliate_id' => '1'}))).to have_been_made
         validate_call response
       end
     end
@@ -22,15 +18,15 @@ describe HasOffersV3::AffiliateBilling do
     end
   end
 
-  describe '.create_invoice' do
+  describe '#create_invoice' do
     context 'when data is specified' do
       it 'makes a proper request call' do
         stub_call
         response = subject.create_invoice(data: {affiliate_id: 1, start_date: '2014-10-01', end_date: '2014-10-30'})
-        a_request(:post, url).with(body: hash_including({
+        expect(a_request(:post, url).with(body: hash_including({
           'Method' => 'createInvoice',
           'data'   => {'affiliate_id' => '1', 'start_date' => '2014-10-01', 'end_date' => '2014-10-30'}
-        })).should have_been_made
+        }))).to have_been_made
         validate_call response
       end
     end
@@ -42,12 +38,12 @@ describe HasOffersV3::AffiliateBilling do
     end
   end
 
-  describe '.find_invoice_by_id' do
+  describe '#find_invoice_by_id' do
     context 'when ID is specified' do
       it 'makes a proper request call' do
         stub_call
         response = subject.find_invoice_by_id(id: '1')
-        a_request(:post, url).with(body: hash_including({'Method' => 'findInvoiceById', 'id' => '1'})).should have_been_made
+        expect(a_request(:post, url).with(body: hash_including({'Method' => 'findInvoiceById', 'id' => '1'}))).to have_been_made
         validate_call response
       end
     end
@@ -59,16 +55,16 @@ describe HasOffersV3::AffiliateBilling do
     end
   end
 
-  describe '.add_invoice_item' do
+  describe '#add_invoice_item' do
     context 'when invoice ID and data is specified' do
       it 'makes a proper request call' do
         stub_call
         response = subject.add_invoice_item(invoice_id: 1, data: {memo: 'abc'})
-        a_request(:post, url).with(body: hash_including({
+        expect(a_request(:post, url).with(body: hash_including({
           'Method'     => 'addInvoiceItem',
           'invoice_id' => '1',
           'data'       => {'memo' => 'abc'}
-        })).should have_been_made
+        }))).to have_been_made
         validate_call response
       end
     end
@@ -86,12 +82,12 @@ describe HasOffersV3::AffiliateBilling do
     end
   end
 
-  describe '.remove_invoice_item' do
+  describe '#remove_invoice_item' do
     context 'when ID is specified' do
       it 'makes a proper request call' do
         stub_call
         response = subject.remove_invoice_item(id: '1')
-        a_request(:post, url).with(body: hash_including({'Method' => 'removeInvoiceItem', 'id' => '1'})).should have_been_made
+        expect(a_request(:post, url).with(body: hash_including({'Method' => 'removeInvoiceItem', 'id' => '1'}))).to have_been_made
         validate_call response
       end
     end

data/spec/lib/affiliate_offer_spec.rb

@@ -1,11 +1,7 @@
-require 'spec_helper'
-
 describe HasOffersV3::AffiliateOffer do
-  subject { HasOffersV3::AffiliateOffer.new }
-
   let(:url)  { api_url 'Affiliate_Offer' }
 
-  describe '.target' do
+  describe '#target' do
     specify { expect(subject.target).to eq('Affiliate_Offer')}
   end
 
@@ -13,8 +9,8 @@ describe HasOffersV3::AffiliateOffer do
     specify { expect(url).to eq('https://api.hasoffers.com/v3/Affiliate_Offer.json') }
   end
 
-  describe '.find_all' do
-    it 'should make a proper request call' do
+  describe '#find_all' do
+    it 'makes a proper request call' do
       stub_call
       response = subject.find_all
       request = a_request(:post, url).with(body: hash_including('Method' => 'findAll'))
@@ -23,8 +19,8 @@ describe HasOffersV3::AffiliateOffer do
     end
   end
 
-  describe '.find_by_id' do
-    it 'should make a proper request call' do
+  describe '#find_by_id' do
+    it 'makes a proper request call' do
       stub_call
       response = subject.find_by_id id: 1
       request = a_request(:post, url).with(body: hash_including('Method' => 'findById', 'id' => '1'))
@@ -34,14 +30,14 @@ describe HasOffersV3::AffiliateOffer do
     end
 
     context 'when there is no id' do
-      it 'should raise exception' do
+      it 'raises exception' do
         expect { subject.find_by_id }.to raise_error ArgumentError
       end
     end
   end
 
-  describe '.get_categories' do
-    it 'should make a proper request call' do
+  describe '#get_categories' do
+    it 'makes a proper request call' do
       stub_call
       response = subject.get_categories ids: [1, 2]
       request = a_request(:post, url).with(body: hash_including('Method' => 'getCategories'))
@@ -51,14 +47,14 @@ describe HasOffersV3::AffiliateOffer do
     end
 
     context 'when there is no id' do
-      it 'should raise exception' do
+      it 'raises exception' do
         expect { subject.get_categories }.to raise_error ArgumentError
       end
     end
   end
 
-  describe '.get_target_countries' do
-    it 'should make a proper request call' do
+  describe '#get_target_countries' do
+    it 'makes a proper request call' do
       stub_call
       response = subject.get_target_countries ids: [1, 2]
       request = a_request(:post, url).with(body: hash_including('Method' => 'getTargetCountries'))
@@ -68,14 +64,14 @@ describe HasOffersV3::AffiliateOffer do
     end
 
     context 'when there is no id' do
-      it 'should raise exception' do
+      it 'raises exception' do
         expect { subject.get_target_countries }.to raise_error ArgumentError
       end
     end
   end
 
-  describe '.generate_tracking_link' do
-    it 'should make a proper request call' do
+  describe '#generate_tracking_link' do
+    it 'makes a proper request call' do
       stub_call
       response = subject.generate_tracking_link offer_id: 1
       request = a_request(:post, url).with(body: hash_including('Method' => 'generateTrackingLink'))
@@ -85,14 +81,14 @@ describe HasOffersV3::AffiliateOffer do
     end
 
     context 'when there is no offer_id' do
-      it 'should raise exception' do
+      it 'raises exception' do
         expect { subject.generate_tracking_link }.to raise_error ArgumentError
       end
     end
   end
 
-  describe '.find_my_offers' do
-    it 'should make a proper request call' do
+  describe '#find_my_offers' do
+    it 'makes a proper request call' do
       stub_call
       response = subject.find_my_offers
       request = a_request(:post, url).with(body: hash_including('Method' => 'findMyOffers'))
@@ -102,4 +98,14 @@ describe HasOffersV3::AffiliateOffer do
     end
   end
 
+  describe '#find_my_approved_ffers' do
+    it 'makes a proper request call' do
+      stub_call :get, nil, Regexp.new(url)
+      response = subject.find_my_approved_offers
+      expect(a_request(:get, url).with(query: hash_including({'Method' => 'findMyApprovedOffers'}))).to have_been_made
+
+      validate_call response
+    end
+  end
+
 end