share_a_sale 0.0.1 → 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 78ae24b6850a6550f1364109bd41f3575172aee4
+  data.tar.gz: 59c94670d5d4233f169eb284a29f58c2ddec13f6
+SHA512:
+  metadata.gz: f21e6012289a8bd2bfb0fed2412dd82c5b20cb993adbfd4da821c1955f8e1cfc2ebe877d078c285913734e31c298b6960c85b3bd877cd3c017b25503d05e1d4a
+  data.tar.gz: 4c5bcce1ab52573ba0a5759bdee4cc1fc8201a44ad718dc7224ab2446eb80fb2dfbdc7f92367add910eaaf72661b90e730587b78686a1a4260e95a04505de60a

data/lib/share_a_sale.rb

@@ -1,54 +1,18 @@
-require "share_a_sale/version"
 require 'digest'
 require 'uri'
 require 'rest-client'
 
-module ShareASale
-  SHARE_A_SALE_HOST = "shareasale.com"
-  SHARE_A_SALE_PATH = "/w.cfm"
-  SHARE_A_SALE_VERSION = "1.8"
-
-  class Client < Struct.new(:merchant_id, :token, :api_secret)
-    { banner_list: "bannerList", transaction_detail: "transactionDetail", reference: "reference" }.each do |method, api_action|
-      class_eval <<-EORUBY, __FILE__, __LINE__
-        def #{method}(options = {}, date = Time.now)
-          request('#{api_action}', options, date).execute!
-        end
-      EORUBY
-    end
-
-    def request(action, options, date = Time.now)
-      Request.new(merchant_id, token, api_secret, action, options, date)
-    end
-  end
-
-  class Request < Struct.new(:merchant_id, :token, :api_secret, :action, :options, :date)
-    def date_string
-      date.strftime("%a, %d %b %Y %H:%M:%S GMT")
-    end
+require 'share_a_sale/version'
+require 'share_a_sale/request'
+require 'share_a_sale/client'
 
-    def string_to_hash
-      "#{token}:#{date_string}:#{action}:#{api_secret}"
-    end
 
-    def authentication_hash
-      Digest::SHA256.hexdigest(string_to_hash).upcase
-    end
-
-    def url
-      params = [['merchantId', merchant_id], ['token', token], ['version', SHARE_A_SALE_VERSION], ['action', action], ['date', date.strftime("%D")]] + options.to_a
-      URI::HTTPS.build(host: SHARE_A_SALE_HOST, path: SHARE_A_SALE_PATH, query: URI.encode_www_form(params)).to_s
-    end
-
-    def custom_headers
-      {
-        "x-ShareASale-Date" => date_string,
-        "x-ShareASale-Authentication" => authentication_hash
-      }
-    end
-
-    def execute!
-      RestClient.get(url, custom_headers)
-    end
+module ShareASale
+  def self.client
+    @client ||= ShareASale::Client.new(
+      ENV.fetch('SHAREASALE_MERCH_ID'),
+      ENV.fetch('SHAREASALE_API_TOKEN'),
+      ENV.fetch('SHAREASALE_API_SECRET')
+    )
   end
 end

data/lib/share_a_sale/client.rb

@@ -0,0 +1,17 @@
+module ShareASale
+  class Client < Struct.new(:merchant_id, :token, :api_secret)
+
+    { banner_list: "bannerList", transaction_detail: "transactionDetail", reference: "reference" }.each do |method, api_action|
+      class_eval <<-EORUBY, __FILE__, __LINE__
+        def #{method}(options = {}, date = Time.now.utc)
+          request('#{api_action}', options, date).execute!
+        end
+      EORUBY
+    end
+
+    def request(action, options, date = Time.now.utc)
+      Request.new(merchant_id, token, api_secret, action, options, date)
+    end
+
+  end
+end

data/lib/share_a_sale/request.rb

@@ -0,0 +1,57 @@
+module ShareASale
+  class Request < Struct.new(:merchant_id, :token, :api_secret, :action, :options, :date)
+
+    def date_string
+      date.strftime("%a, %d %b %Y %H:%M:%S GMT")
+    end
+
+    def string_to_hash
+      "#{token}:#{date_string}:#{action}:#{api_secret}"
+    end
+
+    def authentication_hash
+      Digest::SHA256.hexdigest(string_to_hash).upcase
+    end
+
+    def url
+      params = [
+        ['merchantId', merchant_id],
+        ['token', token],
+        ['version', version],
+        ['action', action],
+        ['date', date.strftime("%D")]
+      ] + options.to_a
+
+      URI::HTTPS.build(
+        host:  host,
+        path:  path,
+        query: params.map{|p| p.join('=') }.join('&')
+      ).to_s
+    end
+
+    def custom_headers
+      {
+        "x-ShareASale-Date" => date_string,
+        "x-ShareASale-Authentication" => authentication_hash
+      }
+    end
+
+    def execute!
+      RestClient.get(url, custom_headers)
+    end
+
+  protected
+
+    def host
+      ENV.fetch('SHAREASALE_HOST', 'api.shareasale.com')
+    end
+
+    def path
+      ENV.fetch('SHAREASALE_PATH', '/w.cfm')
+    end
+
+    def version
+      ENV.fetch('SHAREASALE_VERSION', '2.8')
+    end
+  end
+end

data/lib/share_a_sale/version.rb

@@ -1,3 +1,3 @@
 module ShareASale
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/share_a_sale.gemspec

@@ -21,5 +21,5 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'rest-client'
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
-  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rspec", "3.6.0"
 end

data/spec/share_a_sale/client_spec.rb

@@ -0,0 +1,7 @@
+require 'share_a_sale'
+
+describe ShareASale::Client do
+
+  pending 'Add tests 😭'
+
+end

data/spec/share_a_sale/request_spec.rb

@@ -0,0 +1,45 @@
+require 'share_a_sale'
+
+describe ShareASale::Request do
+  context "API metadata" do
+
+    let(:client) do
+      ShareASale::Client.new(
+        1234,
+        'NGc6dg5e9URups5o',
+        'ATj7vd8b7CCjeq9yQUo8cc2w3OThqe2e'
+      )
+    end
+
+    subject do
+      client.request(
+        'bannerList',
+        { param: 'value' },
+        Time.gm(2011, 04, 14, 22, 44, 22)
+      )
+    end
+
+    specify do
+      expect(subject.date_string).to eq("Thu, 14 Apr 2011 22:44:22 GMT")
+    end
+
+    specify do
+      expect(subject.string_to_hash).to eq(
+        "NGc6dg5e9URups5o:Thu, 14 Apr 2011 22:44:22 GMT:bannerList:ATj7vd8b7CCjeq9yQUo8cc2w3OThqe2e"
+      )
+    end
+
+    specify do
+      expect(subject.authentication_hash).to eq(
+        "78D54A3051AE0AAAF022AA2DA230B97D5219D82183FEFF71E2D53DEC6057D9F1"
+      )
+    end
+
+    specify do
+      expect(subject.url).to eq(
+        "https://api.shareasale.com/w.cfm?merchantId=1234&token=NGc6dg5e9URups5o&version=2.8&action=bannerList&date=04/14/11&param=value"
+      )
+    end
+
+  end
+end

data/spec/share_a_sale_spec.rb

@@ -1,15 +1,23 @@
 require 'share_a_sale'
 
-module ShareASale
-  describe Request do
-    context "API metadata" do
-      let(:client) { Client.new(1234, 'NGc6dg5e9URups5o', 'ATj7vd8b7CCjeq9yQUo8cc2w3OThqe2e') }
-      subject { client.request('bannerList', { param: 'value' }, Time.gm(2011, 04, 14, 22, 44, 22)) }
-
-      its(:date_string) { should eq "Thu, 14 Apr 2011 22:44:22 GMT" }
-      its(:string_to_hash) { should eq "NGc6dg5e9URups5o:Thu, 14 Apr 2011 22:44:22 GMT:bannerList:ATj7vd8b7CCjeq9yQUo8cc2w3OThqe2e" }
-      its(:authentication_hash) { should eq "78D54A3051AE0AAAF022AA2DA230B97D5219D82183FEFF71E2D53DEC6057D9F1" }
-      its(:url) { should eq "https://shareasale.com/w.cfm?merchantId=1234&token=NGc6dg5e9URups5o&version=1.8&action=bannerList&date=04/14/11&param=value"}
+describe ShareASale do
+
+  describe '.client' do
+    context 'without credentials in ENV' do
+      it 'raises an error' do
+        expect { ShareASale.client }.to raise_error(KeyError)
+      end
+    end
+
+    context 'with credentials in ENV' do
+      it 'returns an instance of ShareASale::Client' do
+        ENV['SHAREASALE_MERCH_ID'] = '123'
+        ENV['SHAREASALE_API_TOKEN'] = 'foo'
+        ENV['SHAREASALE_API_SECRET'] = 'bar'
+
+        expect(ShareASale.client).to be_instance_of(ShareASale::Client)
+      end
     end
   end
+
 end

metadata

@@ -1,80 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: share_a_sale
 version: !ruby/object:Gem::Version
-  version: 0.0.1
-  prerelease: 
+  version: 0.1.0
 platform: ruby
 authors:
 - Tejas Dinkar
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-08 00:00:00.000000000 Z
+date: 2017-05-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.6.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.6.0
 description: Gem to share sales via the Share a Sale Network
 email:
 - tejas@gja.in
@@ -82,49 +73,44 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- !binary |-
-  LmdpdGlnbm9yZQ==
-- !binary |-
-  R2VtZmlsZQ==
-- !binary |-
-  TElDRU5TRS50eHQ=
-- !binary |-
-  UkVBRE1FLm1k
-- !binary |-
-  UmFrZWZpbGU=
-- !binary |-
-  bGliL3NoYXJlX2Ffc2FsZS5yYg==
-- !binary |-
-  bGliL3NoYXJlX2Ffc2FsZS92ZXJzaW9uLnJi
-- !binary |-
-  c2hhcmVfYV9zYWxlLmdlbXNwZWM=
-- !binary |-
-  c3BlYy9zaGFyZV9hX3NhbGVfc3BlYy5yYg==
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/share_a_sale.rb
+- lib/share_a_sale/client.rb
+- lib/share_a_sale/request.rb
+- lib/share_a_sale/version.rb
+- share_a_sale.gemspec
+- spec/share_a_sale/client_spec.rb
+- spec/share_a_sale/request_spec.rb
+- spec/share_a_sale_spec.rb
 homepage: ''
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.5.1
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Gem to share sales via the Share a Sale Network
 test_files:
-- !binary |-
-  c3BlYy9zaGFyZV9hX3NhbGVfc3BlYy5yYg==
+- spec/share_a_sale/client_spec.rb
+- spec/share_a_sale/request_spec.rb
+- spec/share_a_sale_spec.rb