linkshare-oauth2-api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4930165256ed7cc09ecaba18a76ec84c87a0e23d
+  data.tar.gz: 87eeb0821424fb5a60c57e29052c160eccc0396c
+SHA512:
+  metadata.gz: fb2b10702d180772b1c1e15ce7f7e623be8c5ef54c3aa03fe0508e24d7787a79fb93e21f7699361b06cdb603fad9663cca214f73d795e5af5846d49d05377ed9
+  data.tar.gz: 3a6db6a21d4fb354d3fa78c35739326da9435dc38a381e1a048ecb2517fd30865a9d85f4ccfa5029d9cdf779718001acc33ea506509d3d1eb8aa0f3517a36ff9

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 Rudie Shahinian
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,102 @@
+= Linkshare
+
+A Ruby implementation of the Rakutan Linkshare API's. This gem provides access to the following APIs:
+* [Advanced Reports - 1.0][advancedreport]
+* [Coupons - 1.0][coupons]
+* [Link Locator - 1.0][linklocator]
+* [Product Search - 1.0][productsearch]
+* [Advertiser Search - 1.0][advertisersearch]
+* [Events - 1.0][events]
+
+[advancedreport]: https://developers.rakutenmarketing.com/subscribe/apis/info?name=AdvancedReports&version=1.0&provider=LinkShare
+[coupons]: https://developers.rakutenmarketing.com/subscribe/apis/info?name=Coupon&version=1.0&provider=LinkShare
+[linklocator]: https://developers.rakutenmarketing.com/subscribe/apis/info?name=LinkLocator&version=1.0&provider=LinkShare
+[prsoductsearch]: https://developers.rakutenmarketing.com/subscribe/apis/info?name=ProductSearch&version=1.0&provider=LinkShare
+[advancedsearch]: https://developers.rakutenmarketing.com/subscribe/apis/info?name=AdvertiserSearch&version=1.0&provider=LinkShare
+[event]: https://developers.rakutenmarketing.com/subscribe/apis/info?name=Events&version=1.0&provider=LinkShare
+
+## Before You Begin
+
+You will require an account with Linkshare, subscriptions to the API's and OAuth2 credentials which can be obtained by followng the instructions in the [Aquiring your Access Token][accesstoken] document
+
+[accesstoken]: https://developers.rakutenmarketing.com/console/registry/resource/_system/governance/apimgt/applicationdata/provider/RakutenMarketing/artifacts/API_Developer_Portal-Acquiring_Your_Access_Token_Guide.pdf
+
+You will need the following peices of information:
+* AccountID (SID or MID)
+* Account Username
+* Account Password
+* Consumer Key
+* Consumer Secret
+* Security Token
+
+## Installation
+
+To install **linkshare**, run the following command:
+
+```
+  gem install linkshare
+```
+
+Or if you are using **bundler**, add 
+
+```
+  gem 'linkshare'
+```
+
+to your `Gemfile`, and run `bundle install`
+
+Then add the following code to an initializer:
+```
+	require 'linkshare'
+	Linkshare.consumer_key = "#########################"
+	Linkshare.consumer_secret = "#########################"
+	Linkshare.sid = "1234567"
+	Linkshare.username = "username"
+	Linkshare.password = "password"
+	Linkshare.security_token = "##################################################################"
+```
+
+## Usage Examples
+
+```ruby
+	require 'linkshare'
+
+	# Coupons API
+	coupn = Linkshare.coupon
+	coupn.fetch
+	coupn.getCoupons
+
+	...
+
+	# Link Locator API
+	merchants = Linkshare.linklocator.getMerchByAppStatus(:approved) 
+
+	...
+	
+	# Advanced Reports API
+	report = Linkshare.advancedreports.fetchReports(6, '20150101', '20160101')
+
+	...
+
+	# Product Search API
+	products = Linkshare.productsearch
+	products.addKeyword('Toy','keyword')
+	products.getProducts
+
+	...
+
+	# Events API
+	events = Linkshare.events.getEvents
+
+	...
+
+	# Advertiser Search API
+	advertiser = Linkshare.advertisersearch.getAdvertisers ("Example Store")
+```
+
+
+## License
+Copyright (c) 2015 Rudie Shahinian. See [LICENSE][] for
+details.
+
+[license]: LICENSE.md

data/Rakefile

@@ -0,0 +1,34 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Linkshare'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/lib/linkshare.rb

@@ -0,0 +1,62 @@
+require 'oauth2'
+require 'base64'
+require 'json'
+require 'linkshare/request'
+require 'linkshare/response'
+require 'linkshare/strategy'
+require 'linkshare/coupon'
+require 'linkshare/link_locator'
+require 'linkshare/advanced_reports'
+require 'linkshare/product_search'
+require 'linkshare/events'
+require 'linkshare/advertiser_search'
+module Linkshare
+  API_URIS = {
+    coupon: "https://api.rakutenmarketing.com/coupon/1.0",
+    link_locator: "https://api.rakutenmarketing.com/linklocator/1.0",
+    advanced_reports: "https://api.rakutenmarketing.com/advancedreports/1.0",
+    product_search: "https://api.rakutenmarketing.com/productsearch/1.0",
+    events: "https://api.rakutenmarketing.com/events/1.0/transactions",
+    advertiser_search: "https://api.rakutenmarketing.com/advertisersearch/1.0"
+  }
+  SITE = "https://api.rakutenmarketing.com/"
+  TOKEN_URL = "token/"
+
+  class << self
+    attr_accessor :consumer_key, :consumer_secret, :sid, :username, :password, :security_token
+  end
+
+  def self.token
+    @token ||= Linkshare::Strategy.new(client).get_token(Linkshare.username, Linkshare.password, Linkshare.sid);
+  end
+
+  def self.coupon
+    @coupon ||= Linkshare::Coupon.new
+  end
+
+  def self.linklocator
+    @linklocator ||= Linkshare::LinkLocator.new
+  end
+
+  def self.productsearch
+    @productsearch ||= Linkshare::ProductSearch.new
+  end
+
+  def self.advancedreports
+    @advancedreports ||= Linkshare::AdvancedReports.new
+  end
+
+  def self.advertisersearch
+    @advertisersearch ||= Linkshare::AdvertiserSearch.new
+  end
+
+  def self.events
+    @events ||= Linkshare::Events.new
+  end
+
+  protected
+   
+  def self.client
+    @client ||=  OAuth2::Client.new(Linkshare.consumer_key, Linkshare.consumer_secret, :site => SITE, :token_url => TOKEN_URL)
+  end
+end

data/lib/linkshare/advanced_reports.rb

@@ -0,0 +1,45 @@
+module Linkshare
+  class AdvancedReports
+    def initilize()
+      @reportsCSV = ''
+      @reportsRows = []
+      @cols = []
+    end
+    def getCSV
+      @reportsCSV
+    end
+
+    def getReports
+      @reportsRows
+    end
+
+  	def fetchReports(reportid, bdate, edate, nid = '', mid = '')
+      token = Linkshare.security_token
+      params = {
+        'token' => token,
+        'reportid' => reportid,
+        'bdate' => bdate, 
+        'edate' => edate 
+      }
+      unless nid == ''
+        params.merge({ 'nid' => nid})
+      end      
+      unless mid == ''
+        params.merge({ 'mid' => mid})
+      end
+      @reportsRows = []
+  		@reportsCSV = Linkshare::Request.get(Linkshare::API_URIS[:advanced_reports], :params => params).body
+      reportsrows = @reportsCSV.split(/\n/)
+      @cols = reportsrows[0].split(/,/)
+      reportsrows.shift
+      reportsrows.each { |row|
+        r = {}
+        row.split(/,/).each_with_index { | o, i|
+          r[@cols[i]]=o
+        }
+        @reportsRows.push(r)
+      }
+      @reportsRows
+  	end
+  end
+end

data/lib/linkshare/advertiser_search.rb

@@ -0,0 +1,16 @@
+module Linkshare
+  class AdvertiserSearch
+  	def getAdvertisers(merchantname = nil)
+      urlparam = ''
+      if merchantname != nil
+        urlparam = '?merchantname='+merchantname
+      end
+  		l = Linkshare::Response.parse(Linkshare::Request.get(Linkshare::API_URIS[:advertiser_search]+urlparam))
+      if l['result'].has_key?('midlist')
+        l['result']['midlist']['merchant']
+      else 
+        return {}
+      end
+  	end
+  end
+end

data/lib/linkshare/coupon.rb

@@ -0,0 +1,37 @@
+module Linkshare
+  class Coupon
+  	def initialize (query = {})
+  		@totalMatches = 0
+  		@totalPages = 0
+  		@pageNumberRequested = 0
+  		@coupons = []
+  		@query = query
+  	end
+  	def getTotalMatches()
+  		@totalMatches
+  	end
+  	
+  	def getTotalPages()
+  		@totalPages
+  	end
+  	
+  	def getPageNumberRequested()
+  		@pageNumberRequested
+  	end
+  	
+  	def getCoupons()
+  		@coupons
+  	end
+  	def query(query)
+  		@query = query
+  	end
+
+  	def fetch()
+  		data = Linkshare::Response.parse(Linkshare::Request.get(Linkshare::API_URIS[:coupon], :params => @query))
+  		@totalMatches = data["couponfeed"]["TotalMatches"]
+  		@totalPages = data["couponfeed"]["TotalPages"]
+  		@pageNumberRequested = data["couponfeed"]["PageNumberRequested"]
+  		@coupons = data["couponfeed"]["link"]
+  	end
+  end
+end

data/lib/linkshare/events.rb

@@ -0,0 +1,7 @@
+module Linkshare
+  class Events
+  	def getEvents(process_date_start = nil, process_date_end=nil, transaction_date_start=nil, transaction_date_end=nil, limit="1000", page="1")
+  		Linkshare::Response.json_parse(Linkshare::Request.get(Linkshare::API_URIS[:events], {:headers => {'Accept' => 'text/json'}}))
+  	end
+  end
+end

data/lib/linkshare/link_locator.rb

@@ -0,0 +1,55 @@
+module Linkshare
+  class LinkLocator
+    STATUS = {
+      :approved => "approved",
+      :wait => "wait",
+      :approval_extended => "approval extended", 
+      :temp_removed => "temp removed", 
+      :temp_rejected => "temp rejected", 
+      :perm_removed => "perm removed", 
+      :perm_rejected => "perm rejected", 
+      :self_removed => "self removed"
+    }
+  	def getMerchByID(mid)
+  		l = Linkshare::Response.parse(Linkshare::Request.get(Linkshare::API_URIS[:link_locator]+'/getMerchByID/'+mid.to_s))
+      l['getMerchByIDResponse']['return']
+  	end
+
+  	def getMerchByName(name)
+  		l = Linkshare::Response.parse(Linkshare::Request.get(Linkshare::API_URIS[:link_locator]+'/getMerchByName/'+name))
+      l['getMerchByNameResponse']['return']
+  	end
+
+  	def getMerchByCategory(cat)
+  		l = Linkshare::Response.parse(Linkshare::Request.get(Linkshare::API_URIS[:link_locator]+'/getMerchByCategory/'+cat.to_s))
+      l['getMerchByCategoryResponse']['return']
+  	end
+
+  	def getMerchByAppStatus(statusID = STATUS[:approved])
+      l = l = Linkshare::Response.parse(Linkshare::Request.get(Linkshare::API_URIS[:link_locator]+'/getMerchByAppStatus/' + STATUS[statusID]))
+      l['getMerchByAppStatusResponse']['return']
+  	end
+
+  	def getProductLinks(mid, creativeCategory = '0', page = '1')
+  		l = Linkshare::Response.parse(Linkshare::Request.get(Linkshare::API_URIS[:link_locator]+'/getProductLinks/'+mid.to_s+'/'+creativeCategory.to_s+'/-1/'+page.to_s))
+      l['getProductLinksResponse']['return']
+  	end
+
+  	def getDRMLinks(mid, creativeCategory = '0', startDate = '', endDate = '', page = '1')
+  		l = Linkshare::Response.parse(Linkshare::Request.get(Linkshare::API_URIS[:link_locator]+'/getDRMLinks/'+mid.to_s+'/'+creativeCategory.to_s+'/'+startDate+'/'+endDate+'/-1/'+page.to_s))
+      l['getDRMLinksResponse']['return']
+  	end
+
+  	def getBannerLinks(mid, creativeCategory = '0', startDate = '', endDate = '', size = '-1', page = '1')
+      l = Linkshare::Response.parse(Linkshare::Request.get(Linkshare::API_URIS[:link_locator]+'/getBannerLinks/'+mid.to_s+'/'+creativeCategory.to_s+'/'+startDate+'/'+endDate+'/'+size.to_s+'/-1/'+page.to_s))
+      l['getBannerLinksResponse']['return']
+  	end
+
+  	def getTextLinks(mid, creativeCategory = '0', startDate = '', endDate = '', page = '1')
+  		l = Linkshare::Response.parse(Linkshare::Request.get(Linkshare::API_URIS[:link_locator]+'/getTextLinks/'+mid.to_s+'/'+creativeCategory.to_s+'/'+startDate+'/'+endDate+'/-1/'+page.to_s))
+      l['getTextLinksResponse']['return']
+  	end
+
+
+  end
+end

data/lib/linkshare/product_search.rb

@@ -0,0 +1,57 @@
+module Linkshare
+  class ProductSearch
+    def initialize
+      @keywords = []
+      @sorts = []
+      @mid = nil
+      @cat = nil
+      @max = "20"
+      @pagenumber = "1"
+    end
+    def addKeyword(keyword, type = "keyword")
+      @keywords.push({keyword: keyword, type: type})
+    end
+    def clearKeywords
+      @keywords = []
+    end
+    def addSort(sort, type = "desc")
+      @sorts.push({sort: sort, type: type})
+    end
+    def clearSorts
+      @sorts = []
+    end
+    def setCat(cat)
+      @cat = cat
+    end
+    def setMaxResults(maxResults = 20)
+      @max = maxResults.to_s
+    end
+    def setPageNumber(pagenumber = 1)
+      @pagenumber = pagenumber.to_s
+    end    
+    def setMid(mid)
+      @mid = mid.to_s
+    end
+
+  	def getProducts()
+      params = '?'
+      @keywords.each_with_index {|k, i| 
+        if i != 0 
+          params += "&"
+        end
+        params += k[:type]+"="+k[:keyword]
+      }
+      @sorts.each {|s| params += "&sort="+s[:sort]+"&sorttype="+s[:type]}
+      if @cat != nil
+        params += '&cat='+@cat
+      end      
+      if @mid != nil
+        params += '&mid='+@mid
+      end
+      params += '&max='+@max
+      params += '&pagenumber='+@pagenumber
+      Linkshare::Response.parse(Linkshare::Request.get(Linkshare::API_URIS[:product_search]+params))
+  		# ap Linkshare::Request.get('https://api.rakutenmarketing.com/productsearch/1.0?keyword=toy&max=20&pagenumber=1')
+  	end
+  end
+end