hasoffersv3 0.2.6 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 14bbd72a409f04c3d63cf07b9417afdde9c296a7
-  data.tar.gz: 94b5449a542c94b181efa8f3b83fe34b45304f18
+  metadata.gz: 488904130364dca63aaebe483eb85f170bc768ec
+  data.tar.gz: d8e5195ff89cee5f418bf1a806a5b7018a0487ca
 SHA512:
-  metadata.gz: aa0db833b68b053dd514b5a0f6fde0ed8a8152f7f5c9f7b4256133afca5d83275313e0cd5d95d2d848b9b973f440eb5750ff4b435cfb1749aba0a674da7555c3
-  data.tar.gz: be9248e2502ead5ab04769039b52017f1cca049de8b9a8801ae29e8d03166b4bfcbd9593f74ae9b994f7b5e7dead15b76d80f31e12e73014b54ad9f41c86161c
+  metadata.gz: 3851200de016fdbe5e357e93847e333db04cfe8284849b60bc9dfd64d636eb52154b76ba80286431268b53e937680d25f33b47a2c21259847d26caf63ca856be
+  data.tar.gz: 35a1c685c0b32a8db00102bfbbb6bc8326e56724f4e2a5271e9ac381bf3734101b7fb305a19c0c90bf54e02720e80b80d371f5c14b041fc823b4acf209268696

data/.ruby-version

@@ -1 +1 @@
-2.1.2
+2.2.2

data/.travis.yml

@@ -3,6 +3,6 @@ script: bundle exec rspec spec
 rvm:
   - 1.9.3
   - 2.0.0
-  - 2.1.1
   - 2.1.2
+  - 2.2.2
   - ruby-head

data/CHANGELOG.md

@@ -1,3 +1,16 @@
+# 0.4.0
+- [#42] Support "Employee": findAll, find_all_by_ids and find_by_id
+- [#41] Added config option `read_timeout` to changed default timeout to 60
+
+# 0.3.0
+- [#39] Removed depreacted methods. Updated structure to use separated client configs.
+
+# 0.2.7
+- [#37][#38] Support "OfferPixel": findAll, find_all_by_ids, find_by_id, get_allowed_types
+
+# 0.2.6
+- Use `https` by default
+
 # 0.2.5
 - Support "Application/findAllAffiliateTiers" method
 

data/README.md

@@ -1,6 +1,6 @@
 ### Overview 
 
-[![Build status](https://api.travis-ci.org/applift/hasoffersv3.png?branch=master)](http://travis-ci.org/HitFox/hasoffersv3)
+[![Build status](https://api.travis-ci.org/applift/hasoffersv3.png?branch=master)](http://travis-ci.org/applift/hasoffersv3)
 
 ### Synopsis
 
@@ -21,7 +21,20 @@ Supported ruby versions:
 
 ## Usage
 
-Basic usage:
+First, check if the method you want to call is already defined in `hasoffersv3/lib/hasoffersv3/*`. If not, you will need to add the method yourself (either just use your fork or submit a PR with your changes).
+
+Next, create an initializer in your project in `config/intializers` and configure your API credentials like so:
+
+```ruby
+HasOffersV3.configure do |config|
+  config.api_key      = ENV['YOUR_HAS_OFFERS_API_KEY']
+  config.network_id   = ENV['YOUR_HAS_OFFERS_NETWORK_ID']
+  config.read_timeout = 10
+end
+```
+
+You can now use the defined methods, following this pattern:
+
 
 ```ruby
 HasOffersV3::ControllerName.snake_case_method_name
@@ -34,7 +47,27 @@ Naming is the same as in HasOffers documentation, also if it requires attributes
 Examples:
 
 ```ruby
-HasOffersV3::Affiliate.update_payment_method_wire affiliate_id: '877', data: []
+HasOffersV3::Affiliate.update_payment_method_wire({ affiliate_id: '877', data: {} })
+```
+
+  or when working with forms:
+
+```ruby
+HasOffersV3::Advertiser.signup({
+  account: {
+    company: params[:company_name],
+    country: params[:company_country],
+    address1: 'Change me 123',
+    zipcode: '123123'
+  },
+  user: {
+    first_name: params[:user_name],
+    email: params[:user_email],
+    password: params[:user_password],
+    password_confirmation: params[:user_password_confirmation]
+  },
+  return_object: 1
+})
 ```
 
 ## Testing

data/hasoffersv3.gemspec

@@ -4,11 +4,11 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'hasoffersv3/version'
 
 Gem::Specification.new do |s|
-  s.name          = "hasoffersv3"
+  s.name          = 'hasoffersv3'
   s.version       = HasOffersV3::VERSION
   s.platform      = Gem::Platform::RUBY
-  s.authors       = ["Maximilian Seifert", "Timo Rößner"]
-  s.email         = ["ms@hitfox.com", "tr@hitfox.com"]
+  s.authors       = ['Maximilian Seifert', 'Timo Rößner']
+  s.email         = ['ms@hitfox.com', 'tr@hitfox.com']
   s.summary       = %q{REST Client for the HasOffers API, version 3.}
   s.description   = %q{REST Client for the HasOffers API, version 3.}
   s.license       = "MIT"
@@ -16,7 +16,7 @@ Gem::Specification.new do |s|
   s.files         = `git ls-files`.split($/)
   s.executables   = s.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
   s.test_files    = s.files.grep(%r{^(test|spec|features)/})
-  s.require_paths = ["lib"]
+  s.require_paths = ['lib']
 
   s.add_dependency 'activesupport' # for to_param method
   s.add_development_dependency 'webmock'

data/lib/hasoffersv3/advertiser.rb

@@ -1,18 +1,16 @@
 class HasOffersV3
   class Advertiser < Base
-    class << self
-      def find_all_ids
-        post_request 'findAllIds', {}
-      end
+    def find_all_ids
+      post_request 'findAllIds', {}
+    end
 
-      def find_all(params = {})
-        post_request 'findAll', params
-      end
+    def find_all(params = {})
+      post_request 'findAll', params
+    end
 
-      def find_by_id(params = {})
-        requires! params, [:id]
-        post_request 'findById', params
-      end
+    def find_by_id(params = {})
+      requires! params, [:id]
+      post_request 'findById', params
     end
   end
 end

data/lib/hasoffersv3/advertiser_billing.rb

@@ -1,29 +1,27 @@
 class HasOffersV3
   class AdvertiserBilling < Base
-    class << self
-      def find_all_invoices(params = {})
-        post_request 'findAllInvoices', params
-      end
+    def find_all_invoices(params = {})
+      post_request 'findAllInvoices', params
+    end
 
-      def create_invoice(params = {})
-        requires! params, [:data]
-        post_request 'createInvoice', 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 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 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
+    def remove_invoice_item(params = {})
+      requires! params, [:id]
+      post_request 'removeInvoiceItem', params
     end
   end
 end

data/lib/hasoffersv3/advertiser_user.rb

@@ -1,9 +1,7 @@
 class HasOffersV3
   class AdvertiserUser < Base
-    class << self
-      def find_all(params = {})
-        post_request 'findAll', params
-      end
+    def find_all(params = {})
+      post_request 'findAll', params
     end
   end
 end

data/lib/hasoffersv3/affiliate.rb

@@ -1,33 +1,31 @@
 class HasOffersV3
   class Affiliate < Base
-    class << self
-      def find_all(params = {})
-        post_request 'findAll', params
-      end
+    def find_all(params = {})
+      post_request 'findAll', params
+    end
 
-      def find_by_id(params = {})
-        requires! params, [:id]
-        get_request 'findById', params
-      end
+    def find_by_id(params = {})
+      requires! params, [:id]
+      get_request 'findById', params
+    end
 
-      def update_payment_method_wire(params = {})
-        post_request 'updatePaymentMethodWire', params
-      end
+    def update_payment_method_wire(params = {})
+      post_request 'updatePaymentMethodWire', params
+    end
 
-      def update_payment_method_paypal(params = {})
-        post_request 'updatePaymentMethodPaypal', params
-      end
+    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
+    def create (params = {})
+      requires! params, [:data]
+      requires! params[:data], [:zipcode, :company]
+      post_request 'create', params
+    end
 
-      def get_tier(params = {})
-        requires! params, [:id]
-        post_request 'getAffiliateTier', params
-      end
+    def get_tier(params = {})
+      requires! params, [:id]
+      post_request 'getAffiliateTier', params
     end
   end
 end

data/lib/hasoffersv3/affiliate_billing.rb

@@ -1,30 +1,28 @@
 class HasOffersV3
   class AffiliateBilling < Base
-    class << self
-      def find_last_invoice(params = {})
-        requires! params, [:affiliate_id]
-        post_request 'findLastInvoice', params
-      end
+    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 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 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 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
+    def remove_invoice_item(params = {})
+      requires! params, [:id]
+      post_request 'removeInvoiceItem', params
     end
   end
 end

data/lib/hasoffersv3/affiliate_offer.rb

@@ -1,39 +1,39 @@
 class HasOffersV3
   class AffiliateOffer < Base
-    class << self
-
-      def target
-        'Affiliate_Offer'
-      end
+    def self.target
+      'Affiliate_Offer'
+    end
 
-      def find_all(params = {})
-        post_request 'findAll', params
-      end
+    def target
+      'Affiliate_Offer'
+    end
 
-      def find_by_id(params = {})
-        requires! params, [:id]
-        post_request 'findById', params
-      end
+    def find_all(params = {})
+      post_request 'findAll', params
+    end
 
-      def get_categories(params = {})
-        requires! params, [:ids]
-        post_request 'getCategories', params
-      end
+    def find_by_id(params = {})
+      requires! params, [:id]
+      post_request 'findById', params
+    end
 
-      def get_target_countries(params = {})
-        requires! params, [:ids]
-        post_request 'getTargetCountries', params
-      end
+    def get_categories(params = {})
+      requires! params, [:ids]
+      post_request 'getCategories', params
+    end
 
-      def generate_tracking_link(params = {})
-        requires! params, [:offer_id]
-        post_request 'generateTrackingLink', params
-      end
+    def get_target_countries(params = {})
+      requires! params, [:ids]
+      post_request 'getTargetCountries', params
+    end
 
-      def find_my_offers(params = {})
-        post_request 'findMyOffers', params
-      end
+    def generate_tracking_link(params = {})
+      requires! params, [:offer_id]
+      post_request 'generateTrackingLink', params
+    end
 
+    def find_my_offers(params = {})
+      post_request 'findMyOffers', params
     end
   end
 end

data/lib/hasoffersv3/application.rb

@@ -1,9 +1,7 @@
 class HasOffersV3
   class Application < Base
-    class << self
-      def get_payout_tiers(params = {})
-        get_request 'findAllAffiliateTiers', params
-      end
+    def get_payout_tiers(params = {})
+      get_request 'findAllAffiliateTiers', params
     end
   end
 end

data/lib/hasoffersv3/base.rb

@@ -3,43 +3,11 @@ require 'active_support/core_ext/object/to_query'
 
 class HasOffersV3
   class Base
-    class << self
-      def get_request(method, params = {}, &block)
-        if block.nil?
-          make_request(:get, method, params)
-        else
-          page = 1
-          begin
-            response = make_request(:get, method, params.merge(page: page))
-            block.call response
-            page += 1
-          end until page > (response.page_info['page_count'] || 1)
-        end
-      end
-
-      def post_request(method, params = {}, &block)
-        if block.nil?
-          make_request(:post, method, params)
-        else
-          page = 1
-          begin
-            response = make_request(:post, method, params.merge(page: page))
-            block.call response
-            page += 1
-          end until page > (response.page_info['page_count'] || 1)
-        end
-      end
-
-      def requires!(hash, required_params)
-        missing_params = []
-        required_params.each do |param|
-          missing_params.push param unless hash.has_key?(param)
-        end
-        unless missing_params.empty?
-          raise ArgumentError.new("Missing required parameter(s): #{missing_params.join(', ')}")
-        end
-      end
+    def initialize(client = HasOffersV3.client)
+      @client = client
+    end
 
+    class << self
       def target
         name.split('::').last
       end
@@ -48,16 +16,63 @@ class HasOffersV3
         HasOffersV3.client
       end
 
+      def method_missing(meth, *args, &block)
+        new(client).send(meth, *args, &block)
+      end
+
       private
 
       def deprecation(from, to)
         warn "\033[31m[DEPRECATION] `#{ name }.#{ from }` is deprecated. Please use `#{ name }.#{ to }` instead.\033[0m"
       end
+    end
+
+    def get_request(method, params = {}, &block)
+      if block.nil?
+        make_request(:get, method, params)
+      else
+        page = 1
+        begin
+          response = make_request(:get, method, params.merge(page: page))
+          block.call response
+          page += 1
+        end until page > (response.page_info['page_count'] || 1)
+      end
+    end
 
-      def make_request(http_method, method, params)
-        client.request(http_method, target, method, params)
+    def post_request(method, params = {}, &block)
+      if block.nil?
+        make_request(:post, method, params)
+      else
+        page = 1
+        begin
+          response = make_request(:post, method, params.merge(page: page))
+          block.call response
+          page += 1
+        end until page > (response.page_info['page_count'] || 1)
       end
+    end
+
+    def requires!(hash, required_params)
+      missing_params = []
+      required_params.each do |param|
+        missing_params.push param unless hash.has_key?(param)
+      end
+      unless missing_params.empty?
+        raise ArgumentError.new("Missing required parameter(s): #{missing_params.join(', ')}")
+      end
+    end
+
+    def target
+      self.class.target
+    end
+
+    def client
+      @client
+    end
 
+    def make_request(http_method, method, params)
+      @client.request(http_method, target, method, params)
     end
   end
 end

data/lib/hasoffersv3/client.rb

@@ -52,7 +52,7 @@ class HasOffersV3
     def new_http(uri)
       http = Net::HTTP.new(uri.host, uri.port)
       http.use_ssl = true if uri.scheme == 'https'
-      http.read_timeout = 600
+      http.read_timeout = configuration.read_timeout
       http
     end
 

data/lib/hasoffersv3/configuration.rb

@@ -15,6 +15,7 @@ class HasOffersV3
     DEFAULTS = {
       host: 'api.hasoffers.com',
       protocol: 'https',
+      read_timeout: 60,
       base_path: '/v3',
       network_id: '',
       api_key: '',

data/lib/hasoffersv3/conversion.rb

@@ -1,22 +1,15 @@
 class HasOffersV3
   class Conversion < Base
-    class << self
-      def findAll(params = {})
-        deprecation 'findAll', 'find_all'
-        find_all params
-      end
-
-      def find_all(params = {})
-        get_request 'findAll', params
-      end
+    def find_all(params = {})
+      get_request 'findAll', params
+    end
 
-      def find_added_conversions(params = {})
-        get_request 'findAddedConversions', params
-      end
+    def find_added_conversions(params = {})
+      get_request 'findAddedConversions', params
+    end
 
-      def find_updated_conversions(params = {})
-        get_request 'findUpdatedConversions', params
-      end
+    def find_updated_conversions(params = {})
+      get_request 'findUpdatedConversions', params
     end
   end
 end

data/lib/hasoffersv3/employee.rb

@@ -0,0 +1,17 @@
+class HasOffersV3
+  class Employee < Base
+    def find_all(params = {})
+      post_request 'findAll', params
+    end
+
+    def find_all_by_ids(params = {})
+      requires! params, [:ids]
+      post_request 'findAllByIds', params
+    end
+
+    def find_by_id(params = {})
+      requires! params, [:id]
+      post_request 'findById', params
+    end
+  end
+end