viglink-api 0.1.0

data/lib/viglink_api/country.rb

@@ -0,0 +1,18 @@
+# encoding: utf-8
+
+module ViglinkApi
+  module Country
+
+    ##
+    # Retrieve the list of supported Countries
+    #
+    # @return [Hashie::Mash] Country
+    def find_countries
+      options = {}
+      options[:key] = @api_key
+      countries_response = get('/vigcatalog/countries.xml', options)
+      countries_response.response if countries_response.response
+    end
+
+  end
+end

data/lib/viglink_api/deal.rb

@@ -0,0 +1,67 @@
+# encoding: utf-8
+
+module ViglinkApi
+  module Deal
+
+    ##
+    # Retrieve the list of Deals
+    #
+    # @param :full [Boolean] If set to true|y|yes then this will return 
+    # the complete response
+    #
+    # @return [Hashie::Mash] Deal
+    def find_deals(options={})
+      full_response = options.delete(:full) if options[:full]
+      options[:key] = @api_key
+      deals_response = get('/vigcatalog/deals.xml', options)
+
+      if full_response.to_s.to_bool or @api_full_response
+        deals_response.response if deals_response.response
+      else
+        deals_response.response.results.deals if deals_response.response.results
+      end
+    end
+
+    ##
+    # Retrieve the list of Deal Types
+    #
+    # @param :full [Boolean] If set to true|y|yes then this will return 
+    # the complete response
+    #
+    # @return [Hashie::Mash] DealType
+    def find_deal_types(options = {})
+      full_response = options.delete(:full) if options[:full]
+      options[:key] = @api_key
+      deal_types_response = get('/vigcatalog/deal_types.xml', options)
+
+      if full_response.to_s.to_bool or @api_full_response
+        deal_types_response.response if deal_types_response.response
+      else
+        deal_types_response.response.results.deal_types if deal_types_response.response.results
+      end
+    end
+
+  end
+end
+
+=begin
+Optional search parameters for find_deals
+
+Param name         Type         Kind         Allowed Values      Default Value   Description
+end_on             range        filter                                           The end on date a deal is still valid for. Pass in a single date for an exact match, or pass in a range of dates delimited with a dash '-'.
+end_on_max         range        filter                                           The maximum end on date for a deal.
+deal_type          selection    filter                                           The deal type ID a deal belongs to.
+keyword                         query                                            A term or phrase you want to find in the deal name or description.
+keyword_description             query                                            A term or phrase you want to find in the deal description.
+keyword_name                    query                                            A term or phrase you want to find in the deal name.
+merchant           selection    filter                                           The merchant ID of the merchant a deal belongs to.
+merchant_type      selection    filter                                           The merchant type ID that a deal's merchant belongs to.
+page               item         pagination   1-100                1              The page number of the results you want returned.
+results_per_page   item         pagination   1-100                20             The number of deals to return in every response.
+session                         session                                          Zipped info used to build more relevant filter values in the response in order to get back to previous filtered states. You do NOT to generate session value, it is provided in the parameters block. Pass it forward for any additional calls you make.
+site_wide          item         filter       all, yes, no         all            Indicates whether or not a deal applies site wide on a merchant's site, as opposed to being for a specific product or specific category within the merchant's site.
+sort_deal          sort                      relevance, name_asc  relevance      The sort order the deals are returned in
+start_on           range        filter                                           The start on date a deal is valid for. Pass in a single date for an exact match, or pass in a range of dates delimited with a dash '-'.
+start_on_max       range        filter                                           The maximum start on date for a deal.
+start_on_min       range        filter                                           The minimum start on date for a deal.
+=end

data/lib/viglink_api/merchant.rb

@@ -0,0 +1,45 @@
+# encoding: utf-8
+
+module ViglinkApi
+  module Merchant
+
+    ##
+    # Retrieve the list of Merchants
+    #
+    # @param :full [Boolean] If set to true|y|yes then this will return 
+    # the complete response
+    #
+    # @return [Hashie::Mash] Merchant
+    def find_merchants(options={})
+      full_response = options.delete(:full) if options[:full]
+      options[:key] = @api_key
+      merchants_response = get('/vigcatalog/merchants.xml', options)
+
+      if full_response.to_s.to_bool or @api_full_response
+        merchants_response.response if merchants_response.response
+      else
+        merchants_response.response.results.merchants if merchants_response.response.results
+      end
+    end
+
+    ##
+    # Retrieve the list of MerchantTypes
+    #
+    # @param :full [Boolean] If set to true|y|yes then this will return 
+    # the complete response
+    #
+    # @return [Hashie::Mash] MerchantType
+    def find_merchant_types(options={})
+      full_response = options.delete(:full) if options[:full]
+      options[:key] = @api_key
+      merchant_types_response = get('/vigcatalog/merchant_types.xml', options)
+
+      if full_response.to_s.to_bool or @api_full_response
+        merchant_types_response.response if merchant_types_response.response
+      else
+        merchant_types_response.response.results.merchant_types if merchant_types_response.response.results
+      end
+    end
+
+  end
+end

data/lib/viglink_api/product.rb

@@ -0,0 +1,25 @@
+# encoding: utf-8
+
+module ViglinkApi
+  module Product
+
+    ##
+    # Retrieve the list of Products
+    # @param :full [Boolean] If set to true|y|yes then this will return 
+    # the complete response
+    #
+    # @return [Hashie::Mash] Product
+    def find_products(options={})
+      full_response = options.delete(:full) if options[:full]
+      options[:key] = @api_key
+      products_response = get('/vigcatalog/products.xml', options)
+
+      if full_response.to_s.to_bool or @api_full_response
+        products_response.response if products_response.response
+      else
+        products_response.response.results.products if products_response.response.results
+      end
+    end
+
+  end
+end

data/lib/viglink_api/purchases.rb

@@ -0,0 +1,63 @@
+# encoding: utf-8
+require 'forwardable'
+require 'viglink_api/request'
+
+module ViglinkApi
+  class Purchases
+    extend Forwardable
+
+    include Request
+
+    attr_reader :api_secret, :api_cuid_url, :last_date, :period
+
+    ##
+    # Create a new ViglinkApi::Client object
+    #
+    # @params options [Hash]
+    def initialize(options={})
+      @api_secret = options[:api_secret] || ViglinkApi.api_secret
+      @api_cuid_url = options[:api_cuid_url] || ViglinkApi.api_cuid_url
+      @last_date = options[:last_date] || 1.day.ago.strftime("%Y/%m/%d")
+      @period = options[:period] || "day"
+    end
+
+    ##
+    # Create a Faraday::Connection object
+    #
+    # @return [Faraday::Connection]
+    def connection
+      params = {}
+      @connection = Faraday.new(url: api_cuid_url, params: params, headers: default_headers, ssl: {verify:false}) do |faraday|
+        faraday.use FaradayMiddleware::Mashify
+        faraday.use FaradayMiddleware::ParseJson, content_type: /\bjson$/
+        faraday.adapter Faraday.default_adapter
+      end
+    end
+
+
+    def find_purchases(options={})
+      options[:secret] = @api_secret
+      if options.has_key?(:last_date)
+        options[:lastDate] = options.delete(:last_date)
+      else
+        options[:lastDate] = @last_date
+      end
+      unless options.has_key?(:period)
+        options[:period] = @period
+      end
+      purchases_response = get('', options)
+    end
+
+
+    private
+
+    def default_headers
+      headers = {
+        accept: '*/*',
+        content_type: 'text/json',
+        user_agent: "Ruby Gem #{ViglinkApi::VERSION}"
+      }
+    end
+
+  end
+end

data/lib/viglink_api/request.rb

@@ -0,0 +1,30 @@
+# encoding: utf-8
+require 'active_support/core_ext'
+
+module ViglinkApi
+  module Request
+
+    def get(path, options)
+      request(:get, path, options)
+    end
+
+    def post(path, options)
+      request(:post, path, options)
+    end
+
+    def request(method, path, options)
+      response = connection.send(method) do |request|
+      case method
+        when :get
+          request.url(path, options)
+        when :put, :post
+          request.path = path
+          request.body = options.to_xml unless options.empty?
+        end
+      end
+
+      response.body
+    end
+
+  end
+end

data/lib/viglink_api/version.rb

@@ -0,0 +1,3 @@
+module ViglinkApi
+  VERSION = "0.1.0"
+end

data/spec/spec_helper.rb

@@ -0,0 +1,40 @@
+require "viglink-api"
+require "vcr"
+require "simplecov"
+require "simplecov-rcov"
+
+class SimpleCov::Formatter::MergedFormatter
+  def format(result)
+    SimpleCov::Formatter::HTMLFormatter.new.format(result)
+    SimpleCov::Formatter::RcovFormatter.new.format(result)
+  end
+end
+
+SimpleCov.formatter = SimpleCov::Formatter::MergedFormatter
+SimpleCov.start do
+  add_filter '/vendor'
+end
+
+VCR.configure do |c|
+  c.allow_http_connections_when_no_cassette = true
+  c.cassette_library_dir = 'spec/cassettes'
+  c.hook_into :webmock
+  c.configure_rspec_metadata!
+  c.default_cassette_options = {record: :new_episodes}
+
+end
+
+RSpec.configure do |c|
+  c.treat_symbols_as_metadata_keys_with_true_values = true
+
+  # Add gem specific configure for easy access
+  #
+  c.before(:each) do
+    ViglinkApi.configure do |config|
+      config.api_key = 'your-api-key'
+      config.api_url = 'http://catalog.viglink.com'
+      config.api_secret = 'your-secret-key'
+      config.api_cuid_url = 'https://www.viglink.com/service/v1/cuidRevenue'
+    end
+  end
+end

data/spec/viglink_api/client_spec.rb

@@ -0,0 +1,11 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe Viglink::Client do
+
+  it "creates a Faraday::Connection" do
+    client = Viglink::Client.new
+    client.connection.should be_kind_of Faraday::Connection
+  end
+
+end

data/spec/viglink_api/country_spec.rb

@@ -0,0 +1,20 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe Viglink::Country do
+
+  let(:client) { Viglink::Client.new }
+
+  describe "#find_countries" do
+
+    context "without search options" do
+
+      it "returns a list of supported countries", vcr: true do
+        client.find_countries.should be_kind_of Hash
+      end
+
+    end
+
+  end
+
+end

data/spec/viglink_api/deal_spec.rb

@@ -0,0 +1,104 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe Viglink::Deal do
+
+  let(:client) { Viglink::Client.new }
+
+  describe "#find_deals" do
+    context "without search options" do
+
+      before(:each) do
+        @deals_response = client.find_deals
+      end
+
+      it "returns a Hash of deals", vcr: true do
+        @deals_response.should be_kind_of Hash
+      end
+
+      it "retuns the total count of deals", vcr: true do
+        @deals_response[:count].should_not be_nil
+      end
+
+      it "retuns an Array of deals", vcr: true do
+        @deals_response.deal.should_not be_nil
+      end
+
+    end
+
+    context "with search options" do
+
+      before(:each) do
+        @deals_response = client.find_deals({full: true})
+      end
+
+      it "returns a Hash of deals", vcr: true do
+        @deals_response.should be_kind_of Hash
+      end
+
+      context "response resources of merchant" do
+        it "returns the `results`", vcr: true do
+          @deals_response[:results].should_not be_nil
+        end
+
+        it "returns the `parameters`", vcr: true do
+          @deals_response[:parameters].should_not be_nil
+        end
+
+        it "returns an `deals`", vcr: true do
+          @deals_response.results.deals.should_not be_nil
+        end
+      end
+    end
+  end
+
+  describe "#find_deal_types" do
+
+    context "without search options" do
+
+      before(:each) do
+        @deal_types_response = client.find_deal_types
+      end
+
+      it "returns a Hash of deal_types", vcr: true do
+        @deal_types_response.should be_kind_of Hash
+      end
+
+      it "retuns the total count of deal_types", vcr: true do
+        @deal_types_response[:count].should_not be_nil
+      end
+
+      it "retuns an Array of deal_types", vcr: true do
+        @deal_types_response.deal_type.should_not be_nil
+      end
+
+    end
+
+    context "with search options" do
+
+      before(:each) do
+        @deal_types_response = client.find_deal_types({full: true})
+      end
+
+      it "returns a Hash of deal_types", vcr: true do
+        @deal_types_response.should be_kind_of Hash
+      end
+
+      context "response resources of product" do
+        it "returns the `results`", vcr: true do
+          @deal_types_response[:results].should_not be_nil
+        end
+
+        it "returns the `parameters`", vcr: true do
+          @deal_types_response[:parameters].should_not be_nil
+        end
+
+        it "returns an `deal_types`", vcr: true do
+          @deal_types_response.results.deal_types.should_not be_nil
+        end
+      end
+    end
+  end
+
+
+end

data/spec/viglink_api/merchant_spec.rb

@@ -0,0 +1,104 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe Viglink::Merchant do
+
+  let(:client) { Viglink::Client.new }
+
+  describe "#find_merchants" do
+    context "without search options" do
+
+      before(:each) do
+        @merchants_response = client.find_merchants
+      end
+
+      it "returns a Hash of merchants", vcr: true do
+        @merchants_response.should be_kind_of Hash
+      end
+
+      it "retuns the total count of merchants", vcr: true do
+        @merchants_response[:count].should_not be_nil
+      end
+
+      it "retuns an Array of merchants", vcr: true do
+        @merchants_response.merchant.should_not be_nil
+      end
+
+    end
+
+    context "with search options" do
+
+      before(:each) do
+        @merchants_response = client.find_merchants({full: true})
+      end
+
+      it "returns a Hash of merchants", vcr: true do
+        @merchants_response.should be_kind_of Hash
+      end
+
+      context "response resources of merchant" do
+        it "returns the `results`", vcr: true do
+          @merchants_response[:results].should_not be_nil
+        end
+
+        it "returns the `parameters`", vcr: true do
+          @merchants_response[:parameters].should_not be_nil
+        end
+
+        it "returns an `merchants`", vcr: true do
+          @merchants_response.results.merchants.should_not be_nil
+        end
+      end
+    end
+  end
+
+  describe "#find_merchant_types" do
+
+    context "without search options" do
+
+      before(:each) do
+        @merchant_types_response = client.find_merchant_types
+      end
+
+      it "returns a Hash of merchant_types", vcr: true do
+        @merchant_types_response.should be_kind_of Hash
+      end
+
+      it "retuns the total count of merchant_types", vcr: true do
+        @merchant_types_response[:count].should_not be_nil
+      end
+
+      it "retuns an Array of merchant_types", vcr: true do
+        @merchant_types_response.merchant_type.should_not be_nil
+      end
+
+    end
+
+    context "with search options" do
+
+      before(:each) do
+        @merchant_types_response = client.find_merchant_types({full: true})
+      end
+
+      it "returns a Hash of merchant_types", vcr: true do
+        @merchant_types_response.should be_kind_of Hash
+      end
+
+      context "response resources of product" do
+        it "returns the `results`", vcr: true do
+          @merchant_types_response[:results].should_not be_nil
+        end
+
+        it "returns the `parameters`", vcr: true do
+          @merchant_types_response[:parameters].should_not be_nil
+        end
+
+        it "returns an `merchant_types`", vcr: true do
+          @merchant_types_response.results.merchant_types.should_not be_nil
+        end
+      end
+    end
+  end
+
+
+end