marcguyer-cheddargetter-client 0.2.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,14 @@
+*~
+#*#
+*/.DS_Store
+*.marks
+.buildpath
+.project
+.settings
+*.tmproj
+nbproject*
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Marc Guyer
+
+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,7 @@
+= cheddargetter-client
+
+CheddarGetter Client is a wrapper for the CheddarGetter API
+
+== Copyright
+
+Copyright (c) 2009 Marc Guyer. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,56 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "cheddargetter-client"
+    gem.summary = %Q{CheddarGetter Client is a wrapper for the CheddarGetter API}
+    gem.email = "marc@cheddargetter.com"
+    gem.homepage = "http://github.com/marcguyer/cheddargetter-client"
+    gem.authors = ["Marc Guyer"]
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "cheddargetter-client #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:minor: 2
+:patch: 0
+:major: 0

data/cheddargetter-client.gemspec

@@ -0,0 +1,46 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{cheddargetter-client}
+  s.version = "0.2.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Marc Guyer"]
+  s.date = %q{2009-07-30}
+  s.email = %q{marc@cheddargetter.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION.yml",
+     "cheddargetter-client.gemspec",
+     "lib/cheddargetter-client.rb",
+     "test/cheddargetter-client_test.rb",
+     "test/test_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/marcguyer/cheddargetter-client}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{CheddarGetter Client is a wrapper for the CheddarGetter API}
+  s.test_files = [
+    "test/cheddargetter-client_test.rb",
+     "test/test_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/lib/cheddargetter-client.rb

@@ -0,0 +1,246 @@
+require 'rubygems'
+require 'httparty'
+require 'libxml'
+require 'pp'
+require 'json'
+
+module CheddarGetter
+	
+	class Request 
+		include HTTParty
+		headers 'User-Agent' => 'CheddarGetter Client Ruby'
+		format :plain
+		
+		def initialize(url, username, password, productCode = nil)
+			self.class.base_uri url
+			self.class.basic_auth username, password
+			@productCode = productCode
+		end
+		
+		def productCode=(productCode)
+			@productCode = productCode
+		end
+		
+		def plans(filters = nil)
+			return Response.new(request('/plans/get', filters))
+		end
+		
+		def plan(code, id = nil)
+			raise ArgumentError, 'code|id is required' if code.blank? || id.blank?
+			return Response.new(request('/plans/get/' + (id!=nil ? id : code)))
+		end
+		
+		def newPlan(data)
+			return Response.new(request('/plans/new', data))
+		end
+		
+		def editPlan(code, id = nil, data)
+			raise ArgumentError, 'code|id is required' if code.blank? || id.blank?
+			return Response.new(request('/plans/edit/' + (id ? 'id/' + id : 'code/' + code), data))
+		end
+		
+		def deletePlan(code, id)
+			raise ArgumentError, 'code|id is required' if code.blank? || id.blank?
+			return Response.new(request('/plans/delete/' + (id ? 'id/' + id : 'code/' + code)))
+		end
+		
+		def customers(filters = nil)
+			return Response.new(request('/customers/get', filters))
+		end
+		
+		def customer(code, id = nil)
+			raise ArgumentError, 'code|id is required' if code.blank? || id.blank?
+			return Response.new(request('/customers/get/' + (id!=nil ? id : code)))
+		end
+		
+		def newCustomer(data)
+			return Response.new(request('/customers/new', data))
+		end
+		
+		def editCustomer(code, id = nil, data)
+			raise ArgumentError, 'code|id is required' if code.blank? || id.blank?
+			return Response.new(request('/customers/edit/' + (id!=nil ? id : code), data))
+		end
+		
+		def deleteCustomer(code, id = nil)
+			raise ArgumentError, 'code|id is required' if code.blank? || id.blank?
+			return Response.new(request('/customers/delete/' + (id!=nil ? id : code), data)) 
+		end
+		
+		def editSubscription(code, id = nil, data)
+			raise ArgumentError, 'code|id is required' if code.blank? || id.blank?
+			return Response.new(request('/customers/edit-subscription/' + (id!=nil ? id : code), data))
+		end
+		
+		def cancelSubscription(code, id = nil)
+			raise ArgumentError, 'code|id is required' if code.blank? || id.blank?
+			return Response.new(request('/customers/cancel/' + (id!=nil ? id : code)))
+		end
+		
+		def addItemQuantity(code, id = nil, data)
+			raise ArgumentError, 'code|id is required' if code.blank? || id.blank?
+			return Response.new(request('/customers/add-item-quantity/' + (id!=nil ? id : code), data))
+		end
+		
+		def removeItemQuantity(code, id = nil, data)
+			raise ArgumentError, 'code|id is required' if code.blank? || id.blank?
+			return Response.new(request('/customers/remove-item-quantity/' + (id!=nil ? id : code), data))
+		end
+		
+		def setItemQuantity(code, id = nil, data)
+			raise ArgumentError, 'code|id is required' if code.blank? || id.blank?
+			return Response.new(request('/customers/set-item-quantity/' + (id!=nil ? id : code), data))
+		end
+		
+		def request(path, args = nil)
+			path = '/xml/' + path + (@productCode!=nil ? '/productCode/' + @productCode : '')
+			# convert multiple adjacent slashes to single slashes
+			path = path.gsub(/(\w)\/+/, '\1/')
+			
+			if (args != nil)
+				return Request.post(path, :query => args).to_s
+			else
+				return Request.get(path).to_s
+			end
+		end
+		
+	end
+	
+	class Response
+		include LibXML
+		
+		def initialize(xml)
+			@document = XML::Document.string(xml)
+			@responseType = @document.root.name
+		end
+		
+		def to_s
+			return @document.to_s
+		end
+		
+		def to_a
+			if (@array != nil)
+				return @array
+			end
+			
+			if (@responseType == 'error') 
+				return [
+					{
+						'code' => @document.root.attributes.get_attribute('code').value,
+						'message' => @document.root.first.content
+					}
+				]
+			end
+			@array = _toArray(@document.root.children);
+			return @array;
+			
+		end
+		
+		def to_json
+			return self.to_a.to_json
+		end
+		
+		def plan(code = nil)
+			raise ArgumentException 'Can\'t get a plan from a response that isn\'t of type \'plans\'' if @responseType != 'plans'
+			raise 'This response contains more than one plan so you need to provide the code for the plan you wish to get' if code.blank? && @document.root.children.length > 1
+			
+			if code.blank?
+				return to_a.first
+			end
+			return to_a[code]
+		end
+		
+		def planItem(code = nil, itemCode = nil)
+			plan = plan(code)
+			raise ArgumentException 'This plan contains more than one item so you need to provide the code for the item you wish to get' if itemCode.blank? && plan['items'].length > 1
+			
+			if itemCode.blank?
+				return plan['items'].first
+			end
+			return plan['items'][itemCode]
+		end
+		
+		def customer(code = nil)
+			raise ArgumentException 'Can\'t get a customer from a response that isn\'t of type \'customers\'' if @responseType != 'customers'
+			raise ArgumentException 'This response contains more than one customer so you need to provide the code for the customer you wish to get' if code.blank? && @document.root.children.length > 1
+			
+			if code.blank?
+				return to_a.first
+			end
+			return to_a[code]
+		end
+		
+		def customerSubscription(code = nil)
+			customer = customer(code)
+			return customer['subscriptions'].first
+		end
+		
+		def customerPlan(code = nil)
+			subscription = customerSubscription(code)
+			return subscription['plans'].first
+		end
+		
+		def customerInvoice(code = nil)
+			subscription = customerSubscription(code)
+			return subscription['invoices'].first
+		end
+		
+		def customerItemQuantity(code = nil, itemCode = nil)
+			subscription = customerSubscription(code)
+			raise ArgumentException 'This customer\'s subscription contains more than one item so you need to provide the code for the item you wish to get' if itemCode.blank? && subscription['items'].length > 1
+			plan = customerPlan(code)
+			if !itemCode.blank?
+				return {
+					'item' => plan['items'][itemCode],
+					'quantity' => subscription['items'][itemCode]
+				}
+			else
+				return {
+					'item' => plan['items'].first,
+					'quantity' => subscription['items'].first
+				}
+			end
+		end
+		
+		private
+		
+		def _toArray(nodes) 
+			array = Hash.new(0)
+			nodes.each { |node|
+				if (!node.element?) 
+					next
+				end
+				
+				if (node.attributes?) #deep
+					if (!node.attributes['code'].blank?)   
+						key = node.attributes['code']
+						array[key] = Hash.new()
+						if (!node.attributes['id'].blank?)
+							array[key] = {
+								'id' => node.attributes['id']
+							}
+						end
+						array[key]['code'] = key
+					else
+						key = node.attributes['id']
+						array[key] = Hash.new(0)
+					end
+					array[key] = array[key].merge(_toArray(node.children))
+				else
+					if (node.children.length > 1) # sub array
+						array[node.name] = _toArray(node.children)
+					else
+						array[node.name] = node.content
+					end
+				end
+			}
+			return array
+		end
+		
+	end
+	
+	class ResponseException < Exception
+		
+	end
+	
+end

data/test/cheddargetter-client_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class CheddargetterClientTest < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'cheddargetter-client'
+
+class Test::Unit::TestCase
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification 
+name: marcguyer-cheddargetter-client
+version: !ruby/object:Gem::Version 
+  version: 0.2.0
+platform: ruby
+authors: 
+- Marc Guyer
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-07-30 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: 
+email: marc@cheddargetter.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION.yml
+- cheddargetter-client.gemspec
+- lib/cheddargetter-client.rb
+- test/cheddargetter-client_test.rb
+- test/test_helper.rb
+has_rdoc: false
+homepage: http://github.com/marcguyer/cheddargetter-client
+licenses: 
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: CheddarGetter Client is a wrapper for the CheddarGetter API
+test_files: 
+- test/cheddargetter-client_test.rb
+- test/test_helper.rb