trustedsearch 1.0.2 → 1.0.3

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZTUxOGJkYmJjYmYwM2QwMTI5YTdiYzE2NmRlMTVhNmYzZjE1OGJjYw==
+    Yzk3ZDA3OWU1MWY2MjczZjRjN2E5MmZlODNhMDgyZWI0YWM1ZjFhNA==
   data.tar.gz: !binary |-
-    ODRlYmMzNTMyNjMzZjkxM2I2MWFjMmMxMzBjYTk3OGRlYzFmZThjZg==
+    NmEwYjdmY2NkZjIwMTg2YWRiMzQ2NTc4MWViMmJmYTdiNzExODUyMA==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    OTQxYmY4NjQxMjlkYjFmMGRkMWVlMWFkZTNlNGQ5MjE4NGExOTg4MWI3ZTM4
-    YmVhYzNlNGI4ZDAxMzM2ZjU1ZWU4ZTc3ZDc0ZWI3ZTZmNzAyOTk1ZTg2OTZl
-    OWJkNjkzZWJjODRkMGVlMjJhYmVkNDE2MmUxMmYyMmJjM2ExZjA=
+    YmY5YTAzZmQzZGEyYzUxNjRmMGZjZTczMDg4MWE5NmEzNjJhMzllZjgxYTJh
+    NDc0YWUxYWNlYmU4NDYwMDA1YTU2MWYxYzA0NWYyN2IxZGY0ZDNiMTc1MDIz
+    OTM4MjQ5ZDA4ZDVhZjllOTIyYmM2NjMwMWZlOThmN2Q5ZTk1ZWM=
   data.tar.gz: !binary |-
-    ZTdiYTc3OWI5NzRkODExM2M1OWZkOTk3NzRmMTUzOGEzZmZmYzdjOTA5NmEy
-    OGJiM2I3Mzk5ZTc0YjVlMjFiZGEzYTU4ZTg1OTdmN2E3ZjhhNTIzN2EyMTRl
-    MWRmY2Q4ZGI4ZjQ1MzllNWE0YzU2NDE1ZjdiNWRlMTExNDA1NDg=
+    MTg3NThlZGE5MzJlN2ZkOGRiYTI0Y2U1Yjk5ZWFmYjRkMDdjNmY1ZGVhNmEw
+    ZjBjYzg0Y2I1Zjk1YWNkNDE5OTA0MDc3ZGE1NzRmZmYyNTRjZjQ2YWU1Zjdi
+    NTVlM2YxOTQ3MzI1MGZkNzg4ZDNlOGEyMzE2NDZhNzc4NTgyYWU=

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 trustedsearch
+
+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.md

@@ -0,0 +1,156 @@
+ruby-trustedsearch
+==================
+trustedSEARCH Ruby Gem
+
+
+Full Documentation: [http://developers.trustedsearch.org](http://developers.trustedsearch.org/)
+
+## <a id="requirement"></a>Requirements
+
+[Ruby](http://www.ruby-lang.org/en/downloads/) 1.9 or above.
+
+
+## <a id="installation"></a>Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'trustedsearch'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install trustedsearch
+
+Once you have your credentials you can manually run rake tasks to access the the api, or you can integrate direction.
+
+## <a id="usage"></a>Usage
+
+The gem is designed to support all existing and future [TRUSTEDSearch API's](http://developers.trustedsearch.org) resources.
+
+To start using the gem, you need to be given your sandbox and production public & private keys.
+
+
+### API Examples
+
+Include the required libs & set your public and private keys
+
+```ruby
+
+require "trustedsearch"
+
+TrustedSearch.public_key = "PUBLIC_KEY"
+TrustedSearch.private_key = "PRIVATE_KEY"
+TrustedSearch.environment = "production"  #default is 'sandbox'
+
+```
+
+
+#### Get All Business for all users locations
+See the [API documentation](http://developers.trustedsearch.org/#/get-business-updates) for a list of parameters for each API resource.
+
+```ruby
+api = TrustedSearch::V1.new
+puts api.getBusinessUpdate().data.to_s
+```
+
+#### Get Business Updates for single location
+See the [API documentation](http://developers.trustedsearch.org/#/get-business-updates) for a list of parameters for each API resource.
+
+```ruby
+api = TrustedSearch::V1.new
+puts api.getBusinessUpdate(534f95e8-1de1-558f-885c-3962f22c9a28).data.to_s
+```
+
+#### Get Business Updates for single location since epoch 1380611103
+See the [API documentation](http://developers.trustedsearch.org/#/get-business-updates) for a list of parameters for each API resource.
+
+```ruby
+api = TrustedSearch::V1.new
+puts api.getBusinessUpdate(	534f95e8-1de1-558f-885c-3962f22c9a28, 1380611103).data.to_s
+```
+
+#### Submit New Business Listings
+
+See the [API documentation](http://developers.trustedsearch.org/#/submitting-a-business) for a list of parameters for each API resource.
+
+```ruby
+business_data = [
+	{
+		:externalId => 'ABC123',
+		:order => {
+			:onBehalfOf => 'Sample Partner',
+			:packages => [
+				9,10
+			]
+		},
+		:contact => {
+			:firstName => "Albert",
+			:lastName => "Einstein",
+			:email => "albert@trustedsearch.org",
+			:phone => "5555555555"
+		},
+		:business => {
+			:name => "Albert's Relativity Lane",
+			:street => "123 Cherry Tree Lane",
+			:city => "Santa Barbara",
+			:state => "CA",
+			:postalCode => "93041",
+			:phoneTollFree =>"(800) 555-5555",
+			:website => "http://www.relativitylane.com",
+			:email => "info@relativitylane.com",
+		}
+	},
+	{
+		:externalId => 'ABC456',
+		:order => {
+			:onBehalfOf => 'Sample Partner',
+			:packages => [
+				9,10
+			]
+		},
+		:contact => {
+			:firstName => "Albert",
+			:lastName => "Einstein",
+			:email => "albert@trustedsearch.org",
+			:phone => "4444444444"
+		},
+		:business => {
+			:name => "Albert's Relativity Lane",
+			:street => "456 Cherry Tree Lane",
+			:city => "Santa Barbara",
+			:state => "CA",
+			:postalCode => "93041",
+			:phoneTollFree =>"(800) 555-5555",
+			:website => "http://www.relativitylane.com/mc2",
+			:email => "info@relativitylane.com",
+		}
+	}
+]
+
+api = TrustedSearch::V1.new
+response = api.postBusiness(business_data)
+
+# # Ex: v1/directory-listings/:uuid
+uuid = response.data[0]["uuid"]
+```
+
+### Rake Examples
+	
+Get all udpates in your account
+
+	rake v1:updates[YourPublicKey,YourPrivateKey]
+
+Get update for location 534f95e8-1de1-558f-885c-3962f22c9a28
+
+	rake v1:updates[YourPublicKey,YourPrivateKey,534f95e8-1de1-558f-885c-3962f22c9a28]
+
+Get update for location 534f95e8-1de1-558f-885c-3962f22c9a28 since 1380611103
+
+	rake v1:updates[YourPublicKey,YourPrivateKey,534f95e8-1de1-558f-885c-3962f22c9a28,1380611103] 
+
+Submit a new location using JSON data in file relative path "examples/body.json"
+
+	rake v1:submit[YourPublicKey,YourPrivateKey,"examples/body.json"]

data/lib/tasks/v1.rake

@@ -0,0 +1,36 @@
+namespace :v1 do
+	task :default do
+		
+	end
+
+	desc "Get the directory listings updates. [uuid] if not specified, returns all."
+	task :updates, [:public_key, :private_key, :uuid, :since] do |t, args|
+		TrustedSearch.public_key = args.public_key
+		TrustedSearch.private_key = args.private_key
+		TrustedSearch.environment = ( ENV['env'] ? ENV['env'] : 'sandbox')
+		uuid = ( args.uuid.nil? ? nil : args.uuid)
+		since = ( args.since.nil? ? nil : args.since)
+		api = TrustedSearch::V1.new
+		puts api.getBusinessUpdate(uuid, since).data.to_s
+	end
+
+	desc "Submit a listings to be enhanced and created."
+
+	task :submit, [:public_key, :private_key, :file] do |t, args|
+		TrustedSearch.public_key = args.public_key
+		TrustedSearch.private_key = args.private_key
+		TrustedSearch.environment = ( ENV['env'] ? ENV['env'] : 'sandbox')
+		body_file = ( args.file ? args.file : nil)
+		if(body_file.nil?)
+			puts "You must specify a valid body file."
+			next
+		end
+
+		api = TrustedSearch::V1.new
+		file = File.open(body_file, "rb")
+		contents = file.read
+		response = api.postBusiness(JSON.parse(contents))
+		file.close
+		puts response.data
+	end
+end

data/lib/trustedsearch/api.rb

@@ -0,0 +1,35 @@
+module TrustedSearch
+  class Api < APIResource
+  end
+end
+
+module TrustedSearch
+  class V1 < Api
+
+  	def base_path
+  	  if self == APIResource
+  	    raise NotImplementedError.new("APIResource is an abstract class. You should perform actions on its subclasses (i.e. Publisher)")
+  	  end
+  	  "/v1/"
+  	end
+
+  	# Makes an API request to /directory-listings
+  	# If uuid is nil, all are returned. 
+  	# If since is provided as an integer, only changes made since that time are returned.
+  	def getBusinessUpdate(uuid = nil , since = nil)
+  		method_url = 'directory-listings' + ( (uuid) ? "/#{uuid}" : '')
+  		params = {}
+  		if(since)
+  			params[:since] = since
+  		end
+
+  		return self.get(method_url, params)
+  	end
+
+  	#Submit a single business more multiple business for 
+  	def postBusiness( data = [] )
+  		method_url = 'local-business'  		
+  		return self.post(method_url, {} , data )
+  	end
+  end
+end

data/lib/trustedsearch/api_resource.rb

@@ -0,0 +1,127 @@
+module TrustedSearch
+  class APIResource
+    include HTTParty
+
+    def class_name
+      self.class.name.split('::')[-1]
+    end
+
+    def base_path
+      if self == APIResource
+        raise NotImplementedError.new("APIResource is an abstract class. You should perform actions on its subclasses (i.e. Publisher)")
+      end
+      ""
+    end
+
+    def has_keys
+      unless public_key ||= TrustedSearch.public_key
+        raise AuthenticationError.new(
+          "No public_key key provided. Set your public_key using 'TrustedSearch.public_key = <API-KEY>'. " +
+          "You can retrieve your public_key from a TRUSTEDSearch rep. " +
+          "See http://developers.trustedsearch.org/#/getting-started for details."
+        )
+      end
+
+      unless private_key ||= TrustedSearch.private_key
+        raise AuthenticationError.new(
+          "No private_key provided. Set your private_key using 'TrustedSearch.private_key = <API-KEY>'. " +
+          "You can retrieve your private_key from a TRUSTEDSearch rep. " +
+          "See http://developers.trustedsearch.org/#/getting-started for details."
+        )
+      end
+    end
+
+    def get(api_resource, params = {}, body = {})
+      @resource ||= api_resource
+      has_keys()
+
+      raise ArgumentError, "Params must be a Hash; got #{params.class} instead" unless params.is_a? Hash
+
+      timestamp = get_time()
+      
+      url_to_sign = base_path + api_resource
+
+      params.merge!({
+        apikey: TrustedSearch.public_key,
+        signature: sign_request(TrustedSearch.private_key, url_to_sign, body, timestamp ),
+        timestamp: timestamp
+      })
+
+      resource_url = end_point + url_to_sign
+      request('get', resource_url, params, body)
+    end
+
+    def get_time
+      return Time.now.utc.to_i
+    end
+    def post(api_resource, params = {}, body = [])
+      @resource ||= api_resource
+      has_keys()
+
+      raise ArgumentError, "Params must be a Hash; got #{params.class} instead" unless params.is_a? Hash
+
+      timestamp = get_time()
+      
+      url_to_sign = base_path + api_resource
+
+      params.merge!({
+        apikey: TrustedSearch.public_key,
+        signature: sign_request(TrustedSearch.private_key, url_to_sign, body, timestamp ),
+        timestamp: timestamp
+      })
+
+      resource_url = end_point + url_to_sign
+      request('post', resource_url, params, body)
+    end
+
+    def sign_request( private_key, url, body, timestamp )
+
+      body_md5 = ( body.empty? ) ? '' :  Base64.strict_encode64( Digest::MD5.digest(body.to_json) )
+      signature = url + body_md5 + timestamp.to_s
+      signature = Base64.strict_encode64( Digest::HMAC.digest(signature, private_key , Digest::SHA1) )
+      return signature
+    end
+
+    #get the end_point based upon the environment. Default to sandbox.
+    def end_point
+      if(TrustedSearch.environment == 'production')
+        return TrustedSearch.environments[:production][:domain]
+      else
+        return TrustedSearch.environments[:sandbox][:domain]
+      end
+    end
+
+
+    def request(method='get', resource_url, params, body )
+
+      timeout = TrustedSearch.api_timeout
+      begin
+
+        case method
+        when 'get'
+          response = self.class.get(resource_url, query: params, timeout: timeout)
+        when 'post'
+          response = self.class.post(resource_url, {:query => params, :body => body.to_json, :timeout => timeout } )
+        end
+        
+      rescue Timeout::Error
+        raise ConnectionError.new("Timeout error (#{timeout}s)")
+      end
+      process(response)
+    end
+
+
+    def process(response)
+      case response.code
+      when 200, 201, 204
+        APIResponse.new(response)
+      when 400, 404
+        raise InvalidRequestError.new(response.message, response.code)
+      when 401
+        raise AuthenticationError.new(response.message, response.code)
+      else
+        raise Error.new(response.message, response.code)
+      end
+    end
+  end
+end

data/lib/trustedsearch/api_response.rb

@@ -0,0 +1,11 @@
+module TrustedSearch
+  class APIResponse
+    attr_reader :meta, :data, :request
+
+    def initialize(response)
+      @request = response.request
+      @data = JSON.parse(response.body)
+    end
+
+  end
+end

data/lib/trustedsearch/errors/authentication_error.rb

@@ -0,0 +1,4 @@
+module TrustedSearch
+  class AuthenticationError < Error
+  end
+end

data/lib/trustedsearch/errors/connection_error.rb

@@ -0,0 +1,4 @@
+module TrustedSearch
+  class ConnectionError < Error
+  end
+end

data/lib/trustedsearch/errors/error.rb

@@ -0,0 +1,15 @@
+module TrustedSearch
+  class Error < StandardError
+    attr_reader :message, :code
+
+    def initialize(message = nil, code = nil)
+      @message = message
+      @code    = code
+    end
+
+    def to_s
+      code_string = code.nil? ? "" : " (Code #{code})"
+      "#{message}#{code_string}"
+    end
+  end
+end

data/lib/trustedsearch/errors/invalid_request_error.rb

@@ -0,0 +1,4 @@
+module TrustedSearch
+  class InvalidRequestError < Error
+  end
+end

data/lib/trustedsearch/version.rb

@@ -0,0 +1,3 @@
+module TrustedSearch
+  VERSION = "1.0.1"
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: trustedsearch
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - trustedSEARCH Team
@@ -142,7 +142,18 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/tasks/v1.rake
+- lib/trustedsearch/api.rb
+- lib/trustedsearch/api_resource.rb
+- lib/trustedsearch/api_response.rb
+- lib/trustedsearch/errors/authentication_error.rb
+- lib/trustedsearch/errors/connection_error.rb
+- lib/trustedsearch/errors/error.rb
+- lib/trustedsearch/errors/invalid_request_error.rb
+- lib/trustedsearch/version.rb
 - lib/trustedsearch.rb
+- LICENSE
+- README.md
 homepage: https://github.com/trustedsearch/ruby-trustedsearch
 licenses:
 - MIT