big-door 0.0.0

data/lib/big-door/currency.rb

@@ -0,0 +1,25 @@
+module BigDoor
+	class Currency
+		include ClassMethods
+		
+		def initialize(params)
+			params.each_pair do |key, val|
+				self.class.class_eval do
+					# overwrite the .id method and all others
+					self.instance_eval do
+						attr_accessor key
+					end
+				end
+				instance_variable_set("@#{key}", val)
+			end
+		end
+		
+		def self.all
+			perform_request('get', 'currency')
+		end
+		
+		def self.find(params={})
+			perform_request('get', 'currency', params)
+		end
+	end
+end

data/lib/big-door/named_transaction.rb

@@ -0,0 +1,25 @@
+module BigDoor
+	class NamedTransaction
+		include ClassMethods
+		
+		def initialize(params)
+			params.each_pair do |key, val|
+				self.class.class_eval do
+					next if self.instance_methods.include?(key)
+					self.instance_eval do
+						attr_accessor key
+					end
+				end
+				instance_variable_set("@#{key}", val)
+			end
+		end
+		
+		def self.all
+			perform_request('get', 'named_transaction')
+		end
+		
+		def self.find(params={})
+			results = perform_request('get', 'named_transaction', params)
+		end
+	end
+end

data/lib/big-door/named_transaction_group.rb

@@ -0,0 +1,27 @@
+module BigDoor
+	class NamedTransactionGroup
+		include ClassMethods
+		
+		def initialize(params)
+			params.each_pair do |key, val|
+				self.class.class_eval do
+					next if self.instance_methods.include?(key) and key.to_s != 'id'
+					self.instance_eval do
+						attr_accessor key
+					end
+				end
+				instance_variable_set("@#{key}", val)
+			end
+			
+			self.named_transactions = parse_out_classes(params['named_transactions'])
+		end
+		
+		def self.all
+			perform_request('get', 'named_transaction_group')
+		end
+		
+		def self.find(params={})
+			results = perform_request('get', 'named_transaction_group', params)
+		end
+	end
+end

data/lib/big-door/request.rb

@@ -0,0 +1,7 @@
+module BigDoor
+	class Request
+		include HTTParty
+		
+		format :json
+	end
+end

data/lib/big-door/response_codes.rb

@@ -0,0 +1,266 @@
+module BigDoor
+	module ResponseCodes
+		
+		def self.find(args)
+			if args.is_a? Numeric
+				args = {:code => args}
+			end
+			raise ArgumentError, "Expected a Hash but got a #{args.class}" unless args.is_a? Hash
+			CODES.find {|x| x[args.keys.first.to_sym] == args.values.first}
+		end
+
+		CODES = [
+		{:code => 0,
+			:response_condition => "Created",
+			:log => false,
+			:is_error => false,
+			:return_objects_url_with_error => false,
+			:http_response => 201,
+			:http_code_definition => "Created",
+			:reason_phrase => "Created",
+			:header_modifications => "",
+			:value => ""},
+		{:code => 1,
+			:response_condition => "Updated",
+			:log => false,
+			:is_error => false,
+			:return_objects_url_with_error => false,
+			:http_response => 200,
+			:http_code_definition => "OK",
+			:reason_phrase => "Updated",
+			:header_modifications => "",
+			:value => ""},
+		{:code => 2,
+			:response_condition => "Signature Failure Error",
+			:log => true,
+			:is_error => true,
+			:return_objects_url_with_error => false,
+			:http_response => 401,
+			:http_code_definition => "Unauthorized",
+			:reason_phrase => "Invalid signature; review the Request Signature process and retry",
+			:header_modifications => "WWW-Authenticate",
+			:value => "auth-scheme = \"Digest\" nonce = \"random number\""},
+		{:code => 3,
+			:response_condition => "User Cap Error",
+			:log => true,
+			:is_error => true,
+			:return_objects_url_with_error => true,
+			:http_response => 503,
+			:http_code_definition => "Service Unavailable",
+			:reason_phrase => "User Cap met; if applicable,
+			 wait and retry or re-configure caps.",
+			:header_modifications => "",
+			:value => ""},
+		{:code => 4,
+			:response_condition => "Replay (pre) Error",
+			:log => true,
+			:is_error => true,
+			:return_objects_url_with_error => true,
+			:http_response => 503,
+			:http_code_definition => "Service Unavailable",
+			:reason_phrase => "Token previously used (pre); use a unique token",
+			:header_modifications => "",
+			:value => ""},
+		{:code => 5,
+			:response_condition => "No Named Group Primary Error",
+			:log => true,
+			:is_error => true,
+			:return_objects_url_with_error => true,
+			:http_response => 409,
+			:http_code_definition => "Conflict",
+			:reason_phrase => "No Named Group Primary; set a Primary Named Transaction for this group.",
+			:header_modifications => "",
+			:value => ""},
+		{:code => 6,
+			:response_condition => "Variable Amounts Disallowed Error [2]",
+			:log => false,
+			:is_error => true,
+			:return_objects_url_with_error => true,
+			:http_response => 409,
+			:http_code_definition => "Conflict",
+			:reason_phrase => "Variable amounts not allowed; retry without passing amount,
+			 or reconfigure group.",
+			:header_modifications => "",
+			:value => ""},
+		{:code => 7,
+			:response_condition => "Balance Exceeded Error",
+			:log => true,
+			:is_error => true,
+			:return_objects_url_with_error => true,
+			:http_response => 402,
+			:http_code_definition => "Payment Required",
+			:reason_phrase => "Balance exceeded for this user; advise end-user",
+			:header_modifications => "",
+			:value => ""},
+		{:code => 8,
+			:response_condition => "Transaction Error",
+			:log => true,
+			:is_error => true,
+			:return_objects_url_with_error => true,
+			:http_response => 500,
+			:http_code_definition => "Internal Server Error",
+			:reason_phrase => "Transaction error; alert service provider",
+			:header_modifications => "",
+			:value => ""},
+		{:code => 9,
+			:response_condition => "Summary Update Error [3]",
+			:log => false,
+			:is_error => true,
+			:return_objects_url_with_error => true,
+			:http_response => 500,
+			:http_code_definition => "Internal Server Error",
+			:reason_phrase => "Summary update error; alert service provider",
+			:header_modifications => "",
+			:value => ""},
+		{:code => 10,
+			:response_condition => "Replay (post) Error",
+			:log => true,
+			:is_error => true,
+			:return_objects_url_with_error => true,
+			:http_response => 503,
+			:http_code_definition => "Service Unavailable",
+			:reason_phrase => "Token previously used (post); use a unique token",
+			:header_modifications => "",
+			:value => ""},
+		{:code => 11,
+			:response_condition => "Method Not Allowed",
+			:log => true,
+			:is_error => true,
+			:return_objects_url_with_error => false,
+			:http_response => 405,
+			:http_code_definition => "Method Not Allowed",
+			:reason_phrase => "HTTP Method not allowed on this resource",
+			:header_modifications => "",
+			:value => ""},
+		{:code => 12,
+			:response_condition => "Method Not Recognized",
+			:log => true,
+			:is_error => true,
+			:return_objects_url_with_error => false,
+			:http_response => 501,
+			:http_code_definition => "Not Implemented",
+			:reason_phrase => "HTTP Method not recognized.",
+			:header_modifications => "",
+			:value => ""},
+		{:code => 13,
+			:response_condition => "User Disabled",
+			:log => true,
+			:is_error => true,
+			:return_objects_url_with_error => true,
+			:http_response => 403,
+			:http_code_definition => "Forbidden",
+			:reason_phrase => "User has been disabled; contact us to re-enable",
+			:header_modifications => "",
+			:value => ""},
+		{:code => 14,
+			:response_condition => "Named Transaction is_source misconfigured",
+			:log => true,
+			:is_error => true,
+			:return_objects_url_with_error => true,
+			:http_response => 409,
+			:http_code_definition => "Conflict",
+			:reason_phrase => "Named Transaction has incorrect is_source flag. Sales of goods must not be sources",
+			:header_modifications => "",
+			:value => ""},
+		{:code => 15,
+			:response_condition => "Missing Argument",
+			:log => true,
+			:is_error => true,
+			:return_objects_url_with_error => false,
+			:http_response => 405,
+			:http_code_definition => "Method Not Allowed",
+			:reason_phrase => "HTTP Method not allowed because it was missing a required argument",
+			:header_modifications => "",
+			:value => ""},
+		{:code => 16,
+			:response_condition => "Invalid ID or value in GET",
+			:log => true,
+			:is_error => true,
+			:return_objects_url_with_error => false,
+			:http_response => 405,
+			:http_code_definition => "Method Not Allowed",
+			:reason_phrase => "HTTP Method not allowed because it attempted to use a not owned or otherwise invalid resource.",
+			:header_modifications => "",
+			:value => ""},
+		{:code => 17,
+			:response_condition => "Invalid ID or value in POST",
+			:log => true,
+			:is_error => true,
+			:return_objects_url_with_error => false,
+			:http_response => 405,
+			:http_code_definition => "Method Not Allowed",
+			:reason_phrase => "HTTP Method not allowed because it attempted to use a not owned or otherwise invalid resource.",
+			:header_modifications => "",
+			:value => ""},
+		{:code => 18,
+			:response_condition => "Timestamp expired",
+			:log => true,
+			:is_error => true,
+			:return_objects_url_with_error => false,
+			:http_response => 401,
+			:http_code_definition => "Unauthorized",
+			:reason_phrase => "Timestamp has expired; create a new request with a current timestamp.",
+			:header_modifications => "",
+			:value => ""},
+		{:code => 19,
+			:response_condition => "Challenge-response failure",
+			:log => true,
+			:is_error => true,
+			:return_objects_url_with_error => false,
+			:http_response => 401,
+			:http_code_definition => "Unauthorized",
+			:reason_phrase => "6 challenge response failures",
+			:header_modifications => "",
+			:value => ""},
+		{:code => 20,
+			:response_condition => "Challenge-response success",
+			:log => true,
+			:is_error => false,
+			:return_objects_url_with_error => false,
+			:http_response => 200,
+			:http_code_definition => "OK",
+			:reason_phrase => "Challenge-response accepted",
+			:header_modifications => "",
+			:value => ""},
+		{:code => 21,
+			:response_condition => "Malformed input parameter",
+			:log => true,
+			:is_error => true,
+			:return_objects_url_with_error => true,
+			:http_response => 400,
+			:http_code_definition => "Bad Request",
+			:reason_phrase => "Token must be a valid hexidecimal GUID",
+			:header_modifications => "",
+			:value => ""},
+		{:code => 22,
+			:response_condition => "Disabled Named Good Collection",
+			:log => true,
+			:is_error => true,
+			:return_objects_url_with_error => true,
+			:http_response => 409,
+			:http_code_definition => "Conflict",
+			:reason_phrase => "An associated NamedGood has been disabled via its NamedGoodCollection; contact service provider",
+			:header_modifications => "",
+			:value => ""},
+		{:code => 23,
+			:response_condition => "Disabled Named Good",
+			:log => true,
+			:is_error => true,
+			:return_objects_url_with_error => true,
+			:http_response => 409,
+			:http_code_definition => "Conflict",
+			:reason_phrase => "An associated NamedGood has been disabled; contact service provider",
+			:header_modifications => "",
+			:value => ""},
+		{:code => 24,
+			:response_condition => "Resource Found",
+			:log => true,
+			:is_error => false,
+			:return_objects_url_with_error => false,
+			:http_response => 200,
+			:http_code_definition => "OK",
+			:reason_phrase => "The resource was found. Request this resource with verbosity > 0 to retrieve data.",
+			:header_modifications => "",
+			:value => ""}]
+	end
+end

data/lib/big-door/user.rb

@@ -0,0 +1,49 @@
+# [{"sent_good_summaries"=>[], "level_summaries"=>[], "read_only"=>0, "received_good_summaries"=>[], "guid"=>"a24ff58ca0d711df966120ad2f73afad", "created_timestamp"=>1281043384, "modified_timestamp"=>1281043384, "end_user_login"=>"testers", "award_summaries"=>[], "currency_balances"=>[], "resource_name"=>"end_user"}, {}]
+
+module BigDoor
+	class User
+		include ClassMethods
+		
+		def initialize(params)
+			params.each_pair do |key, val|
+				self.class.class_eval do
+					next if self.instance_methods.include?(key)
+					self.instance_eval do
+						attr_accessor key
+					end
+				end
+				instance_variable_set("@#{key}", val)
+			end
+		end
+		
+		def self.all
+			perform_request('get', 'end_user')
+		end
+		
+		def self.create(params)
+			perform_request('post', 'end_user', params)
+		end
+		
+		def self.find(login)
+			perform_request('get', 'end_user', {:id => login})
+		end
+		
+		def transaction
+			perform_request('get', "end_user/#{self.end_user_login}/transaction")
+		end
+		
+		def add_points(named_transaction_group, points)
+			perform_request('post', "named_transaction_group/#{named_transaction_group.id}/execute", {:id => self.end_user_login, :amount => points})
+		end
+		
+		def get_currency_balance(currency=nil)
+			params = {}
+			params[:id] = currency.id.to_s unless currency.nil?
+			result = perform_request('get', "end_user/#{self.end_user_login}/currency_balance", params)
+			result = parse_out_classes(result)
+			result['currency'] = parse_out_classes(result['currency']) unless result.empty?
+
+			return result
+		end
+	end
+end

data/spec/.rspec

@@ -0,0 +1 @@
+--color

data/spec/big-door_spec.rb

@@ -0,0 +1,105 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require 'ruby-debug'
+
+describe "BigDoor" do
+	before do
+		@big_door = BigDoor::Base.new(:app_key => '0d38d9cd41b0440bbf22c0720be58b27', :secret_key => '5d0b2aed7a7149a9aae97d33f6c23b83')
+	end
+	
+	describe "handle errors" do
+		it "should handle a method call that isn't valid" do
+			lambda { @big_door.hello_world }.should raise_error ArgumentError
+		end
+		
+		describe "response codes" do
+			it "should handle an integer" do
+				code = 13
+				BigDoor::ResponseCodes.find(code)[:code].should eql(code)
+			end
+			
+			it "should handle a hash" do
+				BigDoor::ResponseCodes.find(:http_response => 201)[:code].should eql(0)
+			end
+			
+			it "should raise an error if it's passed something that isn't a hash or number" do
+				lambda { BigDoor::ResponseCodes.find("I'm a n00b") }.should raise_error ArgumentError
+			end
+		end
+	end
+	
+	describe "map BigDoor users to Users object" do
+		it "should map params to a user object" do
+			params = {"sent_good_summaries"=>[], "level_summaries"=>[], "read_only"=>0, "received_good_summaries"=>[], "guid"=>"a24ff58ca0d711df966120ad2f73afad", "created_timestamp"=>1281043384, "modified_timestamp"=>1281043384, "end_user_login"=>"testers", "award_summaries"=>[], "currency_balances"=>[], "resource_name"=>"end_user"}
+			
+			user = BigDoor::User.new(params)
+			params.keys.each do |meth|
+				user.public_methods.should include(meth, "#{meth}=")
+			end
+		end
+		
+		it "should get all users" do
+			VCR.use_cassette('user/all', :record => :new_episodes) do
+				@users = BigDoor::User.all
+			end
+			@users.each do |user|
+				user.class.should eql(BigDoor::User)
+			end
+		end
+		
+		it "should create a user with an id that is an email address" do
+			email = "fakeemailer@trada.com"
+			VCR.use_cassette('user/create', :record => :new_episodes) do
+				@response = BigDoor::User.create(:end_user_login => email, :guid => SecureRandom.hex)
+			end
+			
+			@response.end_user_login.should eql(email)
+		end
+		
+		it "should get a specific user" do
+			VCR.use_cassette('user/specific', :record => :new_episodes) do
+				@user = BigDoor::User.find('testers')
+			end
+
+			[*@user].length.should eql(1)
+			@user.end_user_login.should eql('testers')
+		end
+		
+		it "should get a specific user that uses an email address" do
+			email = 'fakeemailer@trada.com'
+			VCR.use_cassette('user/specific', :record => :new_episodes) do
+				@user = BigDoor::User.find(email)
+			end
+
+			[*@user].length.should eql(1)
+			@user.end_user_login.should eql(email)
+		end
+	end
+	
+	describe "handle currency objects" do
+		it "should return all the currency objects" do
+			VCR.use_cassette('currency/currency', :record => :new_episodes) do
+				@currency = BigDoor::Currency.all
+			end
+			@currency.class.should eql(BigDoor::Currency)
+		end
+	end
+	
+	describe "handle named_transaction objects" do
+		it "should return all the named_transaction objects" do
+			VCR.use_cassette('named_transaction/named_transactions', :record => :new_episodes) do
+				@named_transactions = BigDoor::NamedTransaction.all
+			end
+			@named_transactions.first.class.should eql(BigDoor::NamedTransaction)
+		end
+	end
+	
+	describe "handle named_transaction_group objects" do
+		it "should return all the named_transaction_group objects" do
+			VCR.use_cassette('named_transaction_group/all', :record => :new_episodes) do
+				@named_transactions_group = BigDoor::NamedTransactionGroup.all
+			end
+			@named_transactions_group.first.class.should eql(BigDoor::NamedTransactionGroup)
+			[*@named_transactions_group.first.named_transactions].first.class.should eql(BigDoor::NamedTransaction)
+		end
+	end
+end