cantook 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d244a7cbf9c6ff39604a67e2e42345eb16937b4f
+  data.tar.gz: 4b0daa97abbcacd2d4bfc8b76e27ec719f0edb8b
+SHA512:
+  metadata.gz: ab5364abb5bc5a740adbbdba2dea562f3d1a3f04e531b4c046ffae94bc84246676d7916ebc35fa8fdc1a822964314f37fd78f202ead14220a74498b6c6c633b6
+  data.tar.gz: a9b62062f55b20e4ce0c8d14be435d56f13c2e9e572393dbf49f852ba955079f3c9e2c1495af58538a0106d02699b72e3bc56f219db04852fc339dd7990f41fb

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in cantook.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Gordon B. Isnor
+
+MIT License
+
+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,56 @@
+# Cantook
+
+Facilitates Ruby and Ruby on Rails interaction with the Cantook API
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'cantook'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cantook
+
+## Usage
+
+### Simulate a sale
+	base_hash = { username: 'foo', password: 'bar', platform: 'www.cantook.net', organisation_id: 123, sale_state: 'test', format: 'epub', isbn: '123456789asdf' }
+	simulate_hash = { cost: '999', protection: 'acs4', country: nil }
+	cantook = Cantook::SimulateASale.new(base_hash)		
+	
+	if cantook.simulate_a_sale(simulate_hash) 
+		puts "success"
+	else
+		puts "failure"
+	end
+
+### Sale of a publication
+	base_hash = { username: 'foo', password: 'bar', platform: 'www.cantook.net', organisation_id: 123, sale_state 'test', format: 'epub', isbn: '123456789asdf' }
+	sale_hash = { cost: '999', customer_id: '123', transaction_id: 'abc', protection: 'acs4' }
+	cantook = Cantook::SaleOfAPublication.new(base_hash)
+	
+	if cantook.sale_of_a_publication(sale_hash)
+	  puts "success"
+	else
+	  puts "failure"
+	end
+
+### Download a publication
+	base_hash = { username: 'foo', password: 'bar', platform: 'www.cantook.net', organisation_id: 123, sale_state: 'test', format: 'epub', isbn: '123456789asdf' }	
+	download_hash = { customer_id: '123', transaction_id: 'abc', uname: 'Foo Bar' }	
+	cantook = Cantook::DownloadAPublication.new(base_hash)	
+	download_link = cantook.download_a_publication(download_hash)
+	redirect_to download_link
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/cantook.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "cantook"
+  spec.version       = "0.0.1"
+  spec.authors       = ["Gordon B. Isnor"]
+  spec.email         = ["gordonbisnor@gmail.com"]
+  spec.description   = %q{Cantook gem}
+  spec.summary       = %q{Facilitates Ruby and Ruby on Rails interactions with the Cantook API}
+  spec.homepage      = "http://www.github.com/gordonbisnor/cantook"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency('httparty')
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/lib/cantook/base.rb

@@ -0,0 +1,77 @@
+#
+# Base class sets up common functionality for other classes to inherit behavior from
+#
+# @author Gordon B. Isnor
+#
+module Cantook
+
+	class Base
+		
+		# Name							Mandatory		Description
+		# platform					Yes					The platform that you're using to connect to your account. For example : www.entrepotnumerique.com, www.edenlivres.fr, edigita.cantook.net or transcontinental.cantook.net.
+		# organisation_id		Yes					Your merchant number. This number is provided upon registration.
+		# isbn							Yes					The publication's ISBN.
+		# format						Yes					The publication's format (pdf/epub/mobi).
+
+		attr_accessor :base_url,
+			:auth,
+			:username,
+			:password,
+			:platform, 
+			:organisation_id, 
+			:isbn,
+			:format,
+			:response,
+			:sale_state
+
+		# @param [Hash] params
+		# @option params [String] :username - your Cantook API username
+		# @option params [String] :username - your Cantook API password
+		# @option params [String] :platform - your Cantook platform eg 'www.cantook.net'
+		# @option params [String] :organisation_id - your Cantook organisation ID number
+		# @option params [String] :isbn - ISBN of the publication you are selling
+		# @option params [String] :format - format of the publication being sold, eg 'epub' or 'mobi'
+		# @option params [String] :sale_state - use 'test' for test/development, nil for production (real sales)
+		def initialize(params = {})
+			@username = params[:username]
+			@password = params[:password]
+			@platform = params[:platform]
+			@organisation_id = params[:organisation_id]
+			@isbn = params[:isbn]
+			@format = params[:format]
+			@sale_state = params[:sale_state]
+			@base_url = "https://#{platform}/api/organisations/#{organisation_id}"
+			@auth = { username: username, password: password }
+		end
+
+		# @return [Hash] A basic hash of options common to all Cantook requests
+		def base_options
+			{ format: format, isbn: isbn, sale_state: sale_state }
+		end
+		private :base_options
+
+		# @param [Hash] options
+		def get_request options
+			HTTParty.get(request_url, query: options.merge(base_options), basic_auth: auth)
+		end
+		private :get_request
+
+		# @param [Hash] options
+		def post_request options
+			HTTParty.post(request_url, query: options.merge(base_options), basic_auth: auth)
+		end
+		private :post_request
+
+		# @return [Fixnum] the response code of the Cantook request
+		def response_code
+			response.code
+		end
+
+		# @return [Hash] The response hash, with symbolized keys
+		def response_hash
+			response.parsed_response.deep_symbolize_keys!
+		end
+
+	end
+
+end

data/lib/cantook/download_a_publication.rb

@@ -0,0 +1,67 @@
+#
+# Provides a download link that customer should be redirected to
+#
+# @author Gordon B. Isnor
+#
+module Cantook
+	class DownloadAPublication < Cantook::Base
+
+		# https://[platform]/api/organisations/[organisation_id]/customers/[customer_id] /transactions/[transaction_id]/publications/[isbn]/download_links/[format]
+
+		# GET REQUEST
+
+		# PARAMETERS
+		# customer_id			Yes					The client's unique ID number. Alphanumerical characters ("-" and "_" accepted).
+		# transaction_id	Yes					The transaction / purchase basket's unique ID number.
+		# uname						Yes					First and last name of the user. The value of this parameter will appear in the text of the digital watermark that will be placed on the file.
+
+		# RESPONSE CODES
+		# Code	Content									Description
+		# 200		url											Chronodegradable download URL (expires after 1 minute). Redirect user toward this URL.
+		# 400		missing_transaction_id	You did not enter a transaction ID.
+		# 401		access_denied						You do not have access to the resource.
+		# 404		not_found								Your organisation could not be found.
+
+		attr_accessor :customer_id, :transaction_id, :uname
+		
+		# Example:
+		# base_hash = { username: Settings.cantook.username, password: Settings.cantook.password, platform: Settings.cantook.platform, organisation_id: Settings.cantook.organisation_id, sale_state: Settings.cantook.sale_state, format: 'epub', isbn: '123456789asdf' }
+		# download_hash = { customer_id: '123', transaction_id: 'abc', uname: 'Foo Bar' }
+		# cantook = Cantook::DownloadAPublication.new(base_hash)
+		#	download_link = cantook.download_a_publication(download_hash)
+		# redirect_to download_link
+		#
+		# @param [Hash] params
+		# @option params [String] :customer_id - your customer’s unique ID
+		# @option params [String] :transaction_id - the orders unique ID  
+		# @option params [String] :uname - Your customer’s first and last name, for the watermark
+		# @return [String] If successful, returns the download link 
+		def download_a_publication(params)
+			self.customer_id = params[:customer_id]
+			self.transaction_id = params[:transaction_id]
+			self.uname = params[:uname]
+			do_request
+			response.parsed_response
+		end
+
+		# sets and returns the response
+		def do_request
+			self.response = get_request(options)
+		end
+		private :do_request
+
+		# @return [String] The full url required for this request
+		def request_url
+			base_url + "/customers/#{customer_id}/transactions/#{transaction_id}/publications/#{isbn}/download_links/#{format}"
+		end
+		private :request_url
+
+		# @return [Hash] required parameters not included in the Cantook::Base base_options hash
+		def options
+			{ customer_id: customer_id, transaction_id: transaction_id, uname: uname }
+		end
+		private :options
+
+	end
+
+end

data/lib/cantook/sale_of_a_publication.rb

@@ -0,0 +1,114 @@
+#
+# Notifies Cantook of sale
+#
+# @author Gordon B. Isnor
+#
+module Cantook
+	class SaleOfAPublication < Cantook::Base
+
+		# https://[platform]/api/organisations/[organisation_id]/publications/[isbn]/sales
+		
+		# POST REQUEST
+		
+		# PARAMETERS
+		# Name								Mandatory	Description
+		# cost								Yes				The price of the sale in cents (e.g., $19.99 => 1999).
+		# protection					Yes				The type of protection on the sold publication (none/watermark/acs4/acs4_time_limited).
+		# customer_id					Yes				Your client's unique ID number. Alphanumerical characters only ("-" and "_" also accepted).
+		# transaction_id			Yes				The transaction / purchase basket's unique ID number. Multiple sales can be added to a basket, as long as they have the same unique ID number and are related to a single user. Alphanumerical characters only ("-" and "_" also accepted).
+		# credit_card_prefix	No				4 first numbers of the credit card number used for payment. It allows the publisher to check if the territory constraints (determined by these 4 first numbers) are respected.
+		# sale_state					No				The sale state. By default, a sale is always in "active" state, but it is possible to specify that the sale must be in "test" state using this parameter. Possible values: active / test
+		# country							No				The country which will be considered to validate the price of the publication. Value by default: the country of your organization. ISO 3166-1 Alpha-3 (can, fra, ita) format.
+		# aggregator					No				When a parent store makes a sale for one of it's child store, this field represents the ID of the parent store.
+		# uname								No				First and last name of the user. The value of this parameter will appear in the text of the digital watermark that will be placed on the file. When this parameter is provided on Sale API call, the watermarking delay will be shortened on the download request (the download will begin as soon as the user clicks on the download button instead of waiting for the platform to generate the watermarked copy).
+
+		# RESPONSE CODES
+		# Code	Content									Description
+		# 201		created									The sale has been added successfully.
+		# 400		cannot_sell							You cannot sell this publication.
+		# 400		missing_isbn						You did not enter the ISBN.
+		# 400		missing_format					You did not enter the format.
+		# 400		invalid_format					The selected format is not available for this publication.
+		# 400		missing_cost						You did not enter the price.
+		# 400		invalid_cost						The price does not correspond to the price in the Platform.
+		# 400		missing_customer_id			You did not enter your client's unique ID number.
+		# 400		missing_transaction_id	You did not enter the transaction's unique ID number.
+		# 400		missing_protection			You did not enter the protection type.
+		# 400		invalid_protection			This protection is not available for this format of the publication.
+		# 400		invalid_sale_state			The sale state is invalid.
+		# 401		duplicate								The sale already exists.
+		# 401		access_denied						You do not have access to the resource.
+		# 404		not_found								Your organization could not be found.
+		# 503		service_unavailable			A problem has occured while connecting to the server.
+
+		# TEST BOOKS
+		# Title: test-1. PDF format: 9990000000001 ePub format: 9991000000001 protection: watermark (“protection=watermark”) cost: $0, 0 euro (“cost=0”)
+		# Title: test-2. PDF format: 9990000000002 ePub format: 9991000000002 protection: ACS4 (“protection=acs4”) cost: $1.00, 1.00 euro (“cost=100”)
+		# Title: test-3. PDF format: 9990000000003 ePub format: 9991000000003 protection : ACS4 (“protection=acs4”) cost: $0, 0 euro (“cost=0”)
+
+		attr_accessor :cost, 
+			:protection, 
+			:customer_id, 
+			:transaction_id, 
+			:credit_card_prefix, 
+			:sale_state, 
+			:country, 
+			:aggregator, 
+			:uname
+
+		# Example:
+		# base_hash = { username: Settings.cantook.username, password: Settings.cantook.password, platform: Settings.cantook.platform, organisation_id: Settings.cantook.organisation_id, sale_state: Settings.cantook.sale_state, format: 'epub', isbn: '123456789asdf' }
+		# sale_hash = { cost: '999', customer_id: '123', transaction_id: 'abc', protection: 'acs4' }
+		# cantook = Cantook::SaleOfAPublication.new(base_hash)
+		# if cantook.sale_of_a_publication(sale_hash)
+		#	  puts "mais oui"
+		# else
+		#   puts "mais non"
+		# end
+		#
+		# @param [Hash] params
+		# @option params [Integer] :cost - price in cents
+		# @option params [String] :protection - the file’s DRM protection eg 'acs4'
+		# @option params [String] :customer_id - the customer’s unique ID
+		# @option params [String] :transaction_id - the order’s unique ID
+		# @return [True] if response code is 201
+		# @return [False] if resopnse code is anything other than 201	
+		def sale_of_a_publication(params)
+			self.cost = params[:cost]
+			self.protection = params[:protection]
+			self.customer_id = params[:customer_id]
+			self.transaction_id = params[:transaction_id]
+			do_request
+			response.code == 201
+		end
+
+		# sets and returns the response
+		def do_request
+			self.response = post_request(options)
+		end
+		private :do_request
+
+		# @return [String] The full url required for this request
+		def request_url
+			base_url + "/publications/#{isbn}/sales"
+		end
+		private :request_url
+
+		# @return [Hash] required parameters not included in the Cantook::Base base_options hash
+		def options
+			{
+				cost: cost,
+				protection: protection,
+				customer_id: customer_id,
+				transaction_id: transaction_id,
+				credit_card_prefix: credit_card_prefix,
+				sale_state: sale_state,
+				country: country,
+				aggregator: aggregator,
+				uname: uname
+			}
+		end
+		private :options
+
+	end
+end

data/lib/cantook/simulate_a_sale.rb

@@ -0,0 +1,74 @@
+#
+# Simulates a sale to determine if sale will be viable
+#
+# @author Gordon B. Isnor
+#
+module Cantook
+	class SimulateASale < Cantook::Base
+
+		# https://[platform]/api/organisations/[organisation_id]/publications/[isbn]/sales/new
+		
+		# GET REQUEST
+
+		# PARAMETERS
+		# Name							Mandatory		Description
+		# cost							Yes					The price of the sale in cents (e.g., $19.99 => 1999).
+		# protection				Yes					The type of protection on the sold publication (none/watermark/acs4/acs4_time_limited).
+		# country						No					The country which will be considered to validate the price of the publication. Value by default: the country of your organization. ISO 3166-1 alpha-3 (can, fra, ita) format.
+		
+		# RESPONSE CODES
+		# Code 	Content								Description
+		# 200		valid									The simulation was executed successfully.
+		# 400		cannot_sell						You cannot sell this publication.
+		# 400		missing_isbn					You did not enter the ISBN.
+		# 400		missing_format				You did not enter the format.
+		# 400		invalid_format				The selected format is not available for this publication.
+		# 400		missing_cost					You did not enter the price.
+		# 400		invalid_cost					The price does not correspond to the price in the Platform.
+		# 400		missing_protection		You did not enter the protection type.
+		# 400		invalid_protection		This protection is not available for this format of the publication.
+		# 401		access_denied					You do not have access to the resource.
+		# 404		not_found							Your organization could not be found.
+		# 503		service_unavailable		A problem has occured while connecting to the server.
+		
+		attr_accessor :cost, :protection, :country
+
+		# Example:	
+		# base_hash = { username: Settings.cantook.username, password: Settings.cantook.password, platform: Settings.cantook.platform, organisation_id: Settings.cantook.organisation_id, sale_state: Settings.cantook.sale_state, format: 'epub', isbn: '123456789asdf' }
+		# simulate_hash = { cost: '999', protection: 'acs4', country: nil }
+		# cantook = Cantook::SimulateASale.new(base_hash)		
+		# result = cantook.simulate_a_sale(simulate_hash)
+		# @param [Hash] params
+		# @option params [Integer] :cost - price in cents
+		# @option params [String] :protection - the file’s DRM protection eg 'acs4'
+		# @option params [String] :country - eg 'can'
+		# @return [True] if response code is 200
+		# @return [False] if response code is not 200
+		def simulate_a_sale(params)
+			self.cost = params[:cost]
+			self.protection = params[:protection]
+			self.country = params[:country]
+			do_request
+			response.code == 200
+		end
+
+		# sets and returns the response
+		def do_request
+			self.response = get_request(options)
+		end
+		private :do_request
+
+		# @return [String] The full url required for this request
+		def request_url
+			base_url + "/publications/#{isbn}/sales/new"
+		end
+		private :request_url
+
+		# @return [Hash] required parameters not included in the Cantook::Base base_options hash
+		def options
+			{ cost: cost, protection: protection, country: country }
+		end
+		private :options
+
+	end
+end

data/lib/cantook.rb

@@ -0,0 +1,7 @@
+require "cantook/base"
+require "cantook/download_a_publication"
+require "cantook/sale_of_a_publication"
+require "cantook/simulate_a_sale"
+
+module Cantook
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: cantook
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Gordon B. Isnor
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Cantook gem
+email:
+- gordonbisnor@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- cantook.gemspec
+- lib/cantook.rb
+- lib/cantook/base.rb
+- lib/cantook/download_a_publication.rb
+- lib/cantook/sale_of_a_publication.rb
+- lib/cantook/simulate_a_sale.rb
+homepage: http://www.github.com/gordonbisnor/cantook
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Facilitates Ruby and Ruby on Rails interactions with the Cantook API
+test_files: []
+has_rdoc: