hasoffersv3 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b36a6dc2d698ab001e81abab9d81817768a0b380
-  data.tar.gz: 742c1ac5faff8ef98652e7215bc924d2e8dafa2f
+  metadata.gz: 4756bb80ad0c0810d52a7eeb37a54583f353b215
+  data.tar.gz: 381f65f864de2725357e2f4a7a9a5e0dd2fe25ae
 SHA512:
-  metadata.gz: faad76a0e86ee5d00fa3332bdec0027b7fa73b6f17f013a06ce93a6d47813f4db3e5a7837d524f1f235b4a021386661efc9a2565a20917cfd40dabd12270cb5f
-  data.tar.gz: ce2014031b7e6409ef398afdd507a95a9d0d970cb65e70f9e8a2a12cfbed31b7c20e6cc8ee6be6251dafe68139302734e897b5392947f44bf6847ee0ec9faeec
+  metadata.gz: 0f8cfd576d622db0094c2e2c4b1e558a111b62e180daa69e634a49ea16630badc5f84891f0d3104ca1dc15e4a8a4155cb4dcc24d8020879e5a98d765689e3296
+  data.tar.gz: b49e82d36cef0696416f0d42d4426fc048ec51dd61d88995092960b6bb04ee8403e820b351850e79a6334266fb778bd76d2948540ae4081c80263e159789fcc6

data/.ruby-version

@@ -1 +1 @@
-ruby-2.0.0-p353
+2.1.2

data/.travis.yml

@@ -2,4 +2,7 @@ language: ruby
 script: bundle exec rspec spec
 rvm:
   - 1.9.3
+  - 2.0.0
   - 2.1.1
+  - 2.1.2
+  - ruby-head

data/Gemfile

@@ -1,2 +1,7 @@
 source "https://rubygems.org"
 gemspec
+
+# To support Ruby 2.2.0
+group :test do
+  gem 'safe_yaml', github: 'dtao/safe_yaml'
+end

data/README.md

@@ -12,6 +12,8 @@ Supported ruby versions:
 
 *   1.9.3
 *   2.0
+*   2.1
+*   2.2
 
 ## Installation
 

data/lib/hasoffersv3/adapter.rb

@@ -0,0 +1,30 @@
+class HasOffersV3
+  class Adapter
+    attr_reader :configuration
+
+    def initialize(configuration, target)
+      @configuration = configuration
+      @target = target
+    end
+
+    def with_configuration(&block)
+      previous_config = HasOffersV3.configuration
+      HasOffersV3.configuration = @configuration
+      begin
+        yield
+      ensure
+        HasOffersV3.configuration = previous_config
+      end
+    end
+
+    def method_missing(meth, *args, &block)
+      if @target.respond_to?(meth)
+        with_configuration do
+          @target.send(meth, *args, &block)
+        end
+      else
+        super
+      end
+    end
+  end
+end

data/lib/hasoffersv3/advertiser.rb

@@ -1,4 +1,4 @@
-module HasOffersV3
+class HasOffersV3
   class Advertiser < Base
     class << self
       def find_all_ids

data/lib/hasoffersv3/advertiser_user.rb

@@ -1,4 +1,4 @@
-module HasOffersV3
+class HasOffersV3
   class AdvertiserUser < Base
     class << self
       def find_all(params = {})

data/lib/hasoffersv3/affiliate.rb

@@ -1,4 +1,4 @@
-module HasOffersV3
+class HasOffersV3
   class Affiliate < Base
     class << self
       def find_all(params = {})

data/lib/hasoffersv3/affiliate_offer.rb

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

data/lib/hasoffersv3/base.rb

@@ -1,7 +1,7 @@
 require 'net/http' if RUBY_VERSION < '2'
 require 'active_support/core_ext/object/to_query'
 
-module HasOffersV3
+class HasOffersV3
   class Base
     class << self
       def get_request(method, params = {}, &block)
@@ -44,53 +44,20 @@ module HasOffersV3
         name.split('::').last
       end
 
-    private
-
-      def deprecation(from, to)
-        warn "\033[31m[DEPRECATION] `#{ name }.#{ from }` is deprecated. Please use `#{ name }.#{ to }` instead.\033[0m"
+      def client
+        HasOffersV3.client
       end
 
-      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
-      end
+      private
 
-      def query_string(data_hash)
-        # Rails to_params adds an extra open close brackets to multi-dimensional array parameters which
-        # hasoffers doesn't like, so the gsub here takes care of that.
-        data_hash.to_param.gsub(/\[\]\[/,'[')
+      def deprecation(from, to)
+        warn "\033[31m[DEPRECATION] `#{ name }.#{ from }` is deprecated. Please use `#{ name }.#{ to }` instead.\033[0m"
       end
 
       def make_request(http_method, method, params)
-        data = build_request_params(method, params)
-        if http_method == :post
-          uri               = URI.parse("#{HasOffersV3.configuration.base_uri}/#{target}.json")
-          http              = new_http(uri)
-          raw_request       = Net::HTTP::Post.new(uri.request_uri)
-          raw_request.body  = query_string data
-        else # assume get
-          uri               = URI.parse("#{HasOffersV3.configuration.base_uri}/#{target}.json?#{query_string(data)}")
-          http              = new_http(uri)
-          raw_request       = Net::HTTP::Get.new(uri.request_uri)
-        end
-        http_response = execute_request(http, raw_request)
-
-        Response.new(http_response)
+        client.request(http_method, target, method, params)
       end
 
-      def execute_request(net_http, raw_request)
-        net_http.request raw_request
-      end
-
-      def build_request_params(method, params)
-        params['Method'] = method
-        {
-          NetworkId:    HasOffersV3.configuration.network_id,
-          NetworkToken: HasOffersV3.configuration.api_key,
-        }.merge(params)
-      end
     end
   end
 end

data/lib/hasoffersv3/client.rb

@@ -0,0 +1,64 @@
+require 'net/http' if RUBY_VERSION < '2'
+require 'active_support/core_ext/object/to_query'
+
+class HasOffersV3
+  class Client
+
+    attr_accessor :configuration
+
+    def initialize(configuration)
+      @configuration = configuration
+    end
+
+    def request(http_method, target, method, params)
+      data = build_request_params(method, params)
+
+      target_uri = "#{base_uri}/#{target}.json"
+
+      if http_method == :post
+        uri               = URI.parse(target_uri)
+        http              = new_http(uri)
+        raw_request       = Net::HTTP::Post.new(uri.request_uri)
+        raw_request.body  = query_string data
+      else # assume get
+        uri               = URI.parse("#{target_uri}?#{query_string(data)}")
+        http              = new_http(uri)
+        raw_request       = Net::HTTP::Get.new(uri.request_uri)
+      end
+      http_response = execute_request(http, raw_request)
+
+      Response.new(http_response)
+    end
+
+    def execute_request(net_http, raw_request)
+      net_http.request raw_request
+    end
+
+    def build_request_params(method, params)
+      params['Method'] = method
+      {
+        NetworkId: configuration.network_id,
+        NetworkToken: configuration.api_key,
+        api_key: configuration.api_key
+      }.merge(params)
+    end
+
+    def query_string(data_hash)
+      # Rails to_params adds an extra open close brackets to multi-dimensional array parameters which
+      # hasoffers doesn't like, so the gsub here takes care of that.
+      data_hash.to_param.gsub(/\[\]\[/,'[')
+    end
+
+    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
+    end
+
+    def base_uri
+      configuration.base_uri
+    end
+
+  end
+end

data/lib/hasoffersv3/configuration.rb

@@ -1,11 +1,40 @@
-module HasOffersV3
+class HasOffersV3
   class Configuration
-    attr_accessor :network_id, :api_key, :protocol, :host, :base_path
 
-    def initialize
-      @protocol   = 'http'
-      @host       = 'api.hasoffers.com'
-      @base_path  = '/v3'
+    DEFAULTS = {
+      host: 'api.hasoffers.com',
+      protocol: 'http',
+      base_path: '/v3',
+      network_id: '',
+      api_key: ''
+    }
+
+    DEFAULTS.keys.each do |option_name|
+      define_method option_name do
+        @options[option_name]
+      end
+
+      define_method "#{option_name}=" do |val|
+        @options[option_name] = val
+      end
+    end
+
+    attr_reader :options
+
+    def initialize(options={})
+      defaults = DEFAULTS.dup
+      @options = options.dup
+
+
+      defaults.keys.each do |key|
+        # Symbolize only keys that are needed
+        @options[key] = @options[key.to_s] if @options.has_key?(key.to_s)
+      end
+
+      # Use default when option is not specified or nil
+      defaults.keys.each do |key|
+        @options[key] = defaults[key] if @options[key].nil?
+      end
     end
 
     def base_uri

data/lib/hasoffersv3/conversion.rb

@@ -1,4 +1,4 @@
-module HasOffersV3
+class HasOffersV3
   class Conversion < Base
     class << self
       def findAll(params = {})

data/lib/hasoffersv3/offer.rb

@@ -1,4 +1,4 @@
-module HasOffersV3
+class HasOffersV3
   class Offer < Base
     class << self
       def find_all(params = {})

data/lib/hasoffersv3/raw_log.rb

@@ -1,4 +1,4 @@
-module HasOffersV3
+class HasOffersV3
   class RawLog < Base
     class << self
       def get_download_link(params = {})

data/lib/hasoffersv3/report.rb

@@ -1,4 +1,4 @@
-module HasOffersV3
+class HasOffersV3
   class Report < Base
     Target = 'Report'
 

data/lib/hasoffersv3/response.rb

@@ -1,6 +1,6 @@
 require 'oj'
 
-module HasOffersV3
+class HasOffersV3
   class Response
     attr_reader :body, :http_status_code, :http_message, :http_headers
 

data/lib/hasoffersv3/testing.rb

@@ -1,4 +1,4 @@
-module HasOffersV3
+class HasOffersV3
   class Testing
     class << self
       attr_accessor :__test_mode, :__prepared_request
@@ -20,11 +20,12 @@ module HasOffersV3
       end
 
       def stub_request(status = 200, body = '{"response":{"status":1,"data":[]}}', message = 'mock')
-        self.__prepared_request = begin
-                                    response = Net::HTTPResponse.new '1.1', status, message
-                                    response.stub(:body) { body }
-                                    response
-                                  end
+        self.__prepared_request =
+          begin
+            response = Net::HTTPResponse.new '1.1', status, message
+            response.stub(:body) { body }
+            response
+          end
       end
 
       def execute_stubbed_request
@@ -35,18 +36,14 @@ module HasOffersV3
     end
   end
 
-  class Base
-    class << self
-      private
-
-      alias_method :original_execute_request, :execute_request
+  class Client
+    alias_method :original_execute_request, :execute_request
 
-      def execute_request(net_http, raw_request)
-        if HasOffersV3::Testing.enabled?
-          HasOffersV3::Testing.execute_stubbed_request
-        else
-          original_execute_request net_http, raw_request
-        end
+    def execute_request(net_http, raw_request)
+      if HasOffersV3::Testing.enabled?
+        HasOffersV3::Testing.execute_stubbed_request
+      else
+        original_execute_request net_http, raw_request
       end
     end
   end

data/lib/hasoffersv3/version.rb

@@ -1,3 +1,3 @@
-module HasOffersV3
-  VERSION = '0.1.3'
+class HasOffersV3
+  VERSION = '0.2.0'
 end

data/lib/hasoffersv3.rb

@@ -1,19 +1,65 @@
 require 'net/http'
 
+require 'hasoffersv3/client'
+
 %w!base affiliate response conversion raw_log report configuration advertiser advertiser_user offer!.each do |file|
   require "hasoffersv3/#{file}"
 end
 
-module HasOffersV3
+require 'hasoffersv3/affiliate_offer'
+require 'hasoffersv3/adapter'
+
+class HasOffersV3
+
+  API_TARGETS = {
+    advertisers: HasOffersV3::Advertiser,
+    advertiser_users: HasOffersV3::AdvertiserUser,
+    affiliates: HasOffersV3::Affiliate,
+    affiliate_offers: HasOffersV3::AffiliateOffer,
+    conversions: HasOffersV3::Conversion,
+    offers: HasOffersV3::Offer,
+    raw_logs: HasOffersV3::RawLog,
+    reports: HasOffersV3::Report
+  }
+
   class << self
+
+    def configuration=(config)
+      @configuration = config
+    end
+
     def configuration
-      @configuration ||= Configuration.new
+      @configuration ||= ::HasOffersV3::Configuration.new
     end
 
     def configure &block
-      block.call configuration
+      yield(configuration)
+    end
+
+    def client
+      ::HasOffersV3::Client.new(configuration)
     end
   end
+
+  def configuration
+    @configuration ||= ::HasOffersV3.configuration
+  end
+
+  def configure(&block)
+    yield(configuration)
+  end
+
+  def initialize(options = {})
+    @options = options.dup
+    @configuration = ::HasOffersV3::Configuration.new options
+  end
+
+  API_TARGETS.each do |name, target|
+    define_method name do
+      HasOffersV3::Adapter.new(configuration, target)
+    end
+  end
+
 end
 
 if ENV['RAILS_ENV'] == 'test' ||  ENV['RACK_ENV'] == 'test' || ENV['TEST']

data/spec/lib/adapter_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+describe HasOffersV3::Adapter do
+
+  let(:configuration) { HasOffersV3::Configuration.new(host: 'example.com') }
+  subject { HasOffersV3::Adapter.new(HasOffersV3::Offer, HasOffersV3::Offer) }
+
+  describe '#with_configuration' do
+    it 'should apply for block another config' do
+      default_config = HasOffersV3.configuration
+      expect(HasOffersV3::Offer.client.configuration).to eq(default_config)
+
+      subject.with_configuration do
+        expect(HasOffersV3::Offer.client.configuration).to eq(subject.configuration)
+      end
+
+    end
+  end
+
+end

data/spec/lib/affiliate_offer_spec.rb

@@ -0,0 +1,77 @@
+require 'spec_helper'
+
+describe HasOffersV3::AffiliateOffer do
+  subject { HasOffersV3::AffiliateOffer }
+
+  let(:url)  { api_url 'Affiliate_Offer' }
+
+  describe '.target' do
+    specify { expect(subject.target).to eq('Affiliate_Offer')}
+  end
+
+  context 'urls' do
+    specify { expect(url).to eq('http://api.hasoffers.com/v3/Affiliate_Offer.json') }
+  end
+
+  describe '.find_all' do
+    it 'should make a proper request call' do
+      stub_call
+      response = subject.find_all
+      request = a_request(:post, url).with(body: hash_including('Method' => 'findAll'))
+      expect(request).to have_been_made
+      validate_call response
+    end
+  end
+
+  describe '.find_by_id' do
+    it 'should make 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'))
+      expect(request).to have_been_made
+
+      validate_call response
+    end
+
+    context 'when there is no id' do
+      it 'should raise 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
+      stub_call
+      response = subject.get_categories ids: [1, 2]
+      request = a_request(:post, url).with(body: hash_including('Method' => 'getCategories'))
+      expect(request).to have_been_made
+
+      validate_call response
+    end
+
+    context 'when there is no id' do
+      it 'should raise 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
+      stub_call
+      response = subject.get_target_countries ids: [1, 2]
+      request = a_request(:post, url).with(body: hash_including('Method' => 'getTargetCountries'))
+      expect(request).to have_been_made
+
+      validate_call response
+    end
+
+    context 'when there is no id' do
+      it 'should raise exception' do
+        expect { subject.get_target_countries }.to raise_error ArgumentError
+      end
+    end
+  end
+
+end

data/spec/lib/base_spec.rb

@@ -3,7 +3,7 @@ require 'spec_helper'
 describe HasOffersV3::Base do
   subject { HasOffersV3::Base }
 
-  let(:url)  { Regexp.new api_url('Base') }
+  let(:url) { Regexp.new api_url('Base') }
 
   describe :requires! do
     it 'raise ArgumentError is parameters are missing' do
@@ -15,19 +15,28 @@ describe HasOffersV3::Base do
     it "should make a proper request" do
       stub_call :get
       response = subject.get_request 'test'
-      a_request(:get, url).with(query: hash_including({'Method' => 'test'})).should have_been_made
+      request = a_request(:get, url).with(query: hash_including('Method' => 'test'))
+      expect(request).to have_been_made
       validate_call response
     end
 
     context "with HTTPS enabled" do
+
       before(:each) do
+        @old_protocol = HasOffersV3.configuration.protocol
         HasOffersV3.configuration.protocol = 'https'
       end
 
+      after(:each) do
+        HasOffersV3.configuration.protocol = @old_protocol
+      end
+
       it "should make a proper request" do
         stub_call :get
         response = subject.get_request 'test'
-        a_request(:get, url).with(query: hash_including({'Method' => 'test'})).should have_been_made
+        a_request(:get, url).
+            with(query: hash_including('Method' => 'test')).
+            should have_been_made
         validate_call response
       end
     end

data/spec/lib/client_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe HasOffersV3::Client do
+
+  describe '#base_uri' do
+
+    let(:configuration_to_default_host) { HasOffersV3::Configuration.new }
+    let(:config_for_proxy) {
+      result = HasOffersV3::Configuration.new
+      result.host = 'api.applift.com'
+      result
+    }
+
+    it 'should be different configs' do
+      default_connection = HasOffersV3::Client.new(configuration_to_default_host)
+      expect(default_connection.base_uri).to eq('http://api.hasoffers.com/v3')
+
+      proxy_connection = HasOffersV3::Client.new(config_for_proxy)
+      expect(proxy_connection.base_uri).to eq('http://api.applift.com/v3')
+    end
+
+  end
+
+end

data/spec/lib/hasoffersv3_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+describe HasOffersV3 do
+
+  context 'singleton' do
+    it 'should use default config' do
+      subject = HasOffersV3::Offer.client.configuration
+      expect(subject).to eq(HasOffersV3.configuration)
+    end
+  end
+
+  describe '#configuration' do
+    it 'should create different connections' do
+      subject = HasOffersV3.new
+      expect(subject.configuration).to_not eq(HasOffersV3.configuration)
+    end
+  end
+
+  context 'api' do
+    subject { HasOffersV3.new }
+
+    describe '#offers' do
+      it 'should get offers for current connection' do
+        expect(HasOffersV3::Offer).to receive(:find_all)
+        subject.offers.find_all
+      end
+    end
+  end
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hasoffersv3
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Maximilian Seifert
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-15 00:00:00.000000000 Z
+date: 2014-09-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oj
@@ -115,10 +115,13 @@ files:
 - Rakefile
 - hasoffersv3.gemspec
 - lib/hasoffersv3.rb
+- lib/hasoffersv3/adapter.rb
 - lib/hasoffersv3/advertiser.rb
 - lib/hasoffersv3/advertiser_user.rb
 - lib/hasoffersv3/affiliate.rb
+- lib/hasoffersv3/affiliate_offer.rb
 - lib/hasoffersv3/base.rb
+- lib/hasoffersv3/client.rb
 - lib/hasoffersv3/configuration.rb
 - lib/hasoffersv3/conversion.rb
 - lib/hasoffersv3/offer.rb
@@ -127,11 +130,15 @@ files:
 - lib/hasoffersv3/response.rb
 - lib/hasoffersv3/testing.rb
 - lib/hasoffersv3/version.rb
+- spec/lib/adapter_spec.rb
 - spec/lib/advertiser_spec.rb
 - spec/lib/advertiser_user_spec.rb
+- spec/lib/affiliate_offer_spec.rb
 - spec/lib/affiliate_spec.rb
 - spec/lib/base_spec.rb
+- spec/lib/client_spec.rb
 - spec/lib/conversion_spec.rb
+- spec/lib/hasoffersv3_spec.rb
 - spec/lib/offer_spec.rb
 - spec/lib/raw_log_spec.rb
 - spec/lib/report_spec.rb
@@ -161,12 +168,17 @@ signing_key:
 specification_version: 4
 summary: REST Client for the HasOffers API, version 3.
 test_files:
+- spec/lib/adapter_spec.rb
 - spec/lib/advertiser_spec.rb
 - spec/lib/advertiser_user_spec.rb
+- spec/lib/affiliate_offer_spec.rb
 - spec/lib/affiliate_spec.rb
 - spec/lib/base_spec.rb
+- spec/lib/client_spec.rb
 - spec/lib/conversion_spec.rb
+- spec/lib/hasoffersv3_spec.rb
 - spec/lib/offer_spec.rb
 - spec/lib/raw_log_spec.rb
 - spec/lib/report_spec.rb
 - spec/spec_helper.rb
+has_rdoc: