hasoffersv3 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6af628ce4e57076de7db4b320d0014e7add4e822
-  data.tar.gz: 0eb139d1daf9e20975167f4bd39465056ae189c4
+  metadata.gz: da538c54d138ea729812c0ba860ad4e207657338
+  data.tar.gz: eefed68384c2beda2a459d9060ef5b9b7c3b970d
 SHA512:
-  metadata.gz: 20e97013eff51bfc4801331a404124417a993db2e72c5beabb43000ff833fa0655b820b0a5d242fdf90a79f8fe69686c9a08ce4f5eafd06300b965aa23a7826e
-  data.tar.gz: a0da382c5b472e8f1de5753ab205b4e7454fa0de447020272d38e9ad2cc7cf5083d2852358f20b9d562e9ec95fd21606f10aa0c90be0423e778496d397e692a0
+  metadata.gz: 3a581c12f4dfd240f662b5472381d9e73d56c1b67727810ddac768e04aeb3dd836930194ec312503abdd8c3c791ca14f5bfe6a435656d2fc788ea94c5fcc9014
+  data.tar.gz: 1ab778d3121d3bf5b006369ce03d4b1483cf35400736bf646f0bad978bfcd62deb1f3d4a001c0085e8401b4abbf48bd8c5ac03f6ec8f16dd674b95ebc336818a

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# 0.2.3
+- Support "Offer/generateTrackingLink" method
+- Support "Affiliate/create" method
+
 # 0.2.2
 - Support "Offer/findAllIdsByAffiliateId" method
 - Support "Affiliate_Offer/findMyOffers" method

data/lib/hasoffersv3/advertiser_billing.rb

@@ -0,0 +1,29 @@
+class HasOffersV3
+  class AdvertiserBilling < Base
+    class << self
+      def find_all_invoices(params = {})
+        post_request 'findAllInvoices', params
+      end
+
+      def create_invoice(params = {})
+        requires! params, [:data]
+        post_request 'createInvoice', params
+      end
+
+      def find_invoice_by_id(params = {})
+        requires! params, [:id]
+        post_request 'findInvoiceById', params
+      end
+
+      def add_invoice_item(params = {})
+        requires! params, [:invoice_id, :data]
+        post_request 'addInvoiceItem', params
+      end
+
+      def remove_invoice_item(params = {})
+        requires! params, [:id]
+        post_request 'removeInvoiceItem', params
+      end
+    end
+  end
+end

data/lib/hasoffersv3/affiliate.rb

@@ -17,6 +17,12 @@ class HasOffersV3
       def update_payment_method_paypal(params = {})
         post_request 'updatePaymentMethodPaypal', params
       end
+
+      def create (params = {})
+        requires! params, [:data]
+        requires! params[:data], [:zipcode, :company]
+        post_request 'create', params
+      end
     end
   end
 end

data/lib/hasoffersv3/affiliate_billing.rb

@@ -0,0 +1,30 @@
+class HasOffersV3
+  class AffiliateBilling < Base
+    class << self
+      def find_last_invoice(params = {})
+        requires! params, [:affiliate_id]
+        post_request 'findLastInvoice', params
+      end
+
+      def create_invoice(params = {})
+        requires! params, [:data]
+        post_request 'createInvoice', params
+      end
+
+      def find_invoice_by_id(params = {})
+        requires! params, [:id]
+        post_request 'findInvoiceById', params
+      end
+
+      def add_invoice_item(params = {})
+        requires! params, [:invoice_id, :data]
+        post_request 'addInvoiceItem', params
+      end
+
+      def remove_invoice_item(params = {})
+        requires! params, [:id]
+        post_request 'removeInvoiceItem', params
+      end
+    end
+  end
+end

data/lib/hasoffersv3/offer.rb

@@ -44,6 +44,11 @@ class HasOffersV3
         requires! params, [:id, :affiliate_id]
         post_request 'removePayout', params
       end
+
+      def generate_tracking_link(params = {})
+        requires! params, [:offer_id, :affiliate_id]
+        post_request 'generateTrackingLink', params
+      end
     end
   end
 end

data/lib/hasoffersv3/version.rb

@@ -1,3 +1,3 @@
 class HasOffersV3
-  VERSION = '0.2.2'
+  VERSION = '0.2.3'
 end

data/lib/hasoffersv3.rb

@@ -6,7 +6,9 @@ require 'hasoffersv3/client'
   require "hasoffersv3/#{file}"
 end
 
+require 'hasoffersv3/advertiser_billing'
 require 'hasoffersv3/affiliate_offer'
+require 'hasoffersv3/affiliate_billing'
 require 'hasoffersv3/adapter'
 
 class HasOffersV3
@@ -14,8 +16,10 @@ class HasOffersV3
   API_TARGETS = {
     advertisers: HasOffersV3::Advertiser,
     advertiser_users: HasOffersV3::AdvertiserUser,
+    advertiser_billing: HasOffersV3::AdvertiserBilling,
     affiliates: HasOffersV3::Affiliate,
     affiliate_offers: HasOffersV3::AffiliateOffer,
+    affiliate_billing: HasOffersV3::AffiliateBilling,
     conversions: HasOffersV3::Conversion,
     offers: HasOffersV3::Offer,
     raw_logs: HasOffersV3::RawLog,

data/spec/lib/advertiser_billing_spec.rb

@@ -0,0 +1,97 @@
+require 'spec_helper'
+
+describe HasOffersV3::AdvertiserBilling do
+  subject { HasOffersV3::AdvertiserBilling }
+
+  let(:url) { api_url 'AdvertiserBilling' }
+
+  describe '.find_all_invoices' do
+    it 'makes a proper request call' do
+      stub_call
+      response = subject.find_all_invoices
+      a_request(:post, url).with(body: hash_including({'Method' => 'findAllInvoices'})).should have_been_made
+      validate_call response
+    end
+  end
+
+  describe '.create_invoice' do
+    context 'when data is specified' do
+      it 'makes a proper request call' do
+        stub_call
+        response = subject.create_invoice(data: {advertiser_id: 1, start_date: '2014-10-01', end_date: '2014-10-30'})
+        a_request(:post, url).with(body: hash_including({
+          'Method' => 'createInvoice',
+          'data'   => {'advertiser_id' => '1', 'start_date' => '2014-10-01', 'end_date' => '2014-10-30'}
+        })).should have_been_made
+        validate_call response
+      end
+    end
+
+    context 'when data is not specified' do
+      it 'raises an exception' do
+        expect { subject.create_invoice }.to raise_error ArgumentError
+      end
+    end
+  end
+
+  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
+        validate_call response
+      end
+    end
+
+    context 'when ID is missing' do
+      it 'raises an exception' do
+        expect { subject.find_invoice_by_id }.to raise_error ArgumentError
+      end
+    end
+  end
+
+  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({
+          'Method'     => 'addInvoiceItem',
+          'invoice_id' => '1',
+          'data'       => {'memo' => 'abc'}
+        })).should have_been_made
+        validate_call response
+      end
+    end
+
+    context 'when invoice ID is not specified' do
+      it 'raises an exception' do
+        expect { subject.add_invoice_item(data: {memo: 'abc'}) }.to raise_error ArgumentError
+      end
+    end
+
+    context 'when data is not specified' do
+      it 'raises an exception' do
+        expect { subject.add_invoice_item(invoice_id: 1) }.to raise_error ArgumentError
+      end
+    end
+  end
+
+  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
+        validate_call response
+      end
+    end
+
+    context 'when ID is missing' do
+      it 'raises an exception' do
+        expect { subject.remove_invoice_item }.to raise_error ArgumentError
+      end
+    end
+  end
+end

data/spec/lib/affiliate_billing_spec.rb

@@ -0,0 +1,105 @@
+require 'spec_helper'
+
+describe HasOffersV3::AffiliateBilling do
+  subject { HasOffersV3::AffiliateBilling }
+
+  let(:url) { api_url 'AffiliateBilling' }
+
+  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
+        validate_call response
+      end
+    end
+
+    context 'when affiliate ID is missing' do
+      it 'raises an exception' do
+        expect { subject.find_last_invoice }.to raise_error ArgumentError
+      end
+    end
+  end
+
+  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({
+          'Method' => 'createInvoice',
+          'data'   => {'affiliate_id' => '1', 'start_date' => '2014-10-01', 'end_date' => '2014-10-30'}
+        })).should have_been_made
+        validate_call response
+      end
+    end
+
+    context 'when data is not specified' do
+      it 'raises an exception' do
+        expect { subject.create_invoice }.to raise_error ArgumentError
+      end
+    end
+  end
+
+  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
+        validate_call response
+      end
+    end
+
+    context 'when ID is missing' do
+      it 'raises an exception' do
+        expect { subject.find_invoice_by_id }.to raise_error ArgumentError
+      end
+    end
+  end
+
+  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({
+          'Method'     => 'addInvoiceItem',
+          'invoice_id' => '1',
+          'data'       => {'memo' => 'abc'}
+        })).should have_been_made
+        validate_call response
+      end
+    end
+
+    context 'when invoice ID is not specified' do
+      it 'raises an exception' do
+        expect { subject.add_invoice_item(data: {memo: 'abc'}) }.to raise_error ArgumentError
+      end
+    end
+
+    context 'when data is not specified' do
+      it 'raises an exception' do
+        expect { subject.add_invoice_item(invoice_id: 1) }.to raise_error ArgumentError
+      end
+    end
+  end
+
+  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
+        validate_call response
+      end
+    end
+
+    context 'when ID is missing' do
+      it 'raises an exception' do
+        expect { subject.remove_invoice_item }.to raise_error ArgumentError
+      end
+    end
+  end
+end

data/spec/lib/affiliate_spec.rb

@@ -47,4 +47,26 @@ describe HasOffersV3::Affiliate do
       validate_call response
     end
   end
+
+  describe 'create' do
+    context 'when required params are missing' do
+      it 'should fail without data' do
+        expect { subject.create }.to raise_error ArgumentError
+      end
+      it 'should fail without data["company"]' do
+        expect { subject.create data: { zipcode: 1234567 }}.to raise_error ArgumentError
+      end
+      it 'should fail without data["zipcode"]' do
+        expect { subject.create data: { company: 'xyz@applift.com' }}.to raise_error ArgumentError
+      end
+    end
+
+    it 'should make a successful request call' do
+      response = subject.create data: { company: "xyz@gmail.com", zipcode: "10178" }
+      expect(a_request(:post, url).with(body: hash_including({'Method' => 'create', 'data' => {'company' => 'xyz@gmail.com',
+       'zipcode' => '10178'}}))).to have_been_made
+      validate_call response
+    end
+  end
+
 end

data/spec/lib/offer_spec.rb

@@ -126,4 +126,23 @@ describe HasOffersV3::Offer do
       end
     end
   end
+
+  describe '.generate_tracking_link' do
+    it 'should make a proper request call' do
+      stub_call
+      response = subject.generate_tracking_link offer_id: 1, affiliate_id: 123
+      expect(a_request(:post, url).with(body: hash_including({'Method' => 'generateTrackingLink','offer_id' => '1',
+       'affiliate_id' => '123'}))).to have_been_made
+      validate_call response
+    end
+
+    context 'when required params are missing' do
+      it 'should fail without offer_id' do
+        expect { subject.generate_tracking_link affiliate_id: 1}.to raise_error ArgumentError
+      end
+      it 'should fail without affiliate_id' do
+        expect { subject.generate_tracking_link offer_id: 10 }.to raise_error ArgumentError
+      end
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hasoffersv3
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - Maximilian Seifert
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-19 00:00:00.000000000 Z
+date: 2015-03-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oj
@@ -117,8 +117,10 @@ files:
 - lib/hasoffersv3.rb
 - lib/hasoffersv3/adapter.rb
 - lib/hasoffersv3/advertiser.rb
+- lib/hasoffersv3/advertiser_billing.rb
 - lib/hasoffersv3/advertiser_user.rb
 - lib/hasoffersv3/affiliate.rb
+- lib/hasoffersv3/affiliate_billing.rb
 - lib/hasoffersv3/affiliate_offer.rb
 - lib/hasoffersv3/base.rb
 - lib/hasoffersv3/client.rb
@@ -131,8 +133,10 @@ files:
 - lib/hasoffersv3/testing.rb
 - lib/hasoffersv3/version.rb
 - spec/lib/adapter_spec.rb
+- spec/lib/advertiser_billing_spec.rb
 - spec/lib/advertiser_spec.rb
 - spec/lib/advertiser_user_spec.rb
+- spec/lib/affiliate_billing_spec.rb
 - spec/lib/affiliate_offer_spec.rb
 - spec/lib/affiliate_spec.rb
 - spec/lib/base_spec.rb
@@ -169,8 +173,10 @@ specification_version: 4
 summary: REST Client for the HasOffers API, version 3.
 test_files:
 - spec/lib/adapter_spec.rb
+- spec/lib/advertiser_billing_spec.rb
 - spec/lib/advertiser_spec.rb
 - spec/lib/advertiser_user_spec.rb
+- spec/lib/affiliate_billing_spec.rb
 - spec/lib/affiliate_offer_spec.rb
 - spec/lib/affiliate_spec.rb
 - spec/lib/base_spec.rb