big_door 0.0.1

data/lib/big_door/named_transaction_group.rb

@@ -0,0 +1,74 @@
+module BigDoor
+    #
+    # This module provides NamedTransactionGroup Resource object 
+    # corresponding to /named_transaction_group BigDoor API end point
+    #
+    class NamedTransactionGroup < ResourceWithAssociation
+        ##
+        # Initialize new NamedTransaction object with optional Hash 
+        #
+        # @param [Hash] hash 
+        #   Optional fields to assign to object
+        #
+        def initialize( hash = {} ) 
+            $log.debug( "NamedTransactionGroup init with hash = #{hash.inspect}")
+            default_values = {
+                'end_user_cap'               => 0,
+                'end_user_cap_interval'      => 0,
+            }
+            default_values.merge!( hash )
+            $log.debug( "NamedTransactionGroup default_values = #{default_values.inspect}")
+            super( default_values )
+        end
+
+        ##
+        # Executes this NamedTransaction
+        #
+        #  @param [String] end_user_login
+        #    String representing end_use_login 
+        #
+        #  @param [Hash] payload
+        #    Hash to be converted to HTTP POST form-url-encoded body
+        #
+        #  @param [BigDoor::Client] client
+        #    Initialized BigDoor::Client object
+        #
+        #  @return [Hash] Decoded JSON response if any
+        # 
+        def execute( end_user_login, payload, client )
+            $log.debug('execute transaction');
+
+            # FIXME check for self.resource_id defined
+            # FIXME check end_user_login 
+            uri = sprintf '%s/%s/execute/%s', 
+                end_point, 
+                self.resource_id, 
+                end_user_login
+
+            $log.debug( sprintf 'uri = %s', uri )
+            payload ||= { 'verbosity' => '6' }
+            payload['verbosity'] = 9 unless payload['verbosity']
+            result = client.post( uri , { 'format' => 'json'}, payload )
+            $log.debug(sprintf 'result = %s', result.inspect );
+        end
+
+        ##
+        # Assocaiate this NamedTransactionGroup with NamedTransaction
+        #
+        #  @param [BigDoor::NamedTransaction] transaction
+        #    NamedTransaction to be associated with
+        #
+        #  @param [BigDoor::Client] client
+        #    Initialized BigDoor::Client object
+        #
+        #  @param [Fixnum] primary
+        #    Indicates whether assocatiate NamedTransaction is primary in this
+        #    Named Transaction Group
+        #  
+        #  @return [Hash] Decoded JSON response if any
+        # 
+        def associate_with( transaction, client, primary = 1)
+            super( transaction, client, {'named_transaction_is_primary' => primary } )
+        end
+    end
+end

data/lib/big_door/profile.rb

@@ -0,0 +1,28 @@
+module BigDoor
+    #
+    # This module provides Profile Resource object 
+    # corresponding to /end_user/{id}/profile BigDoor API end point
+    #
+    class Profile < ResourceEndUser
+        ##
+        # Initialize new Profile object with optional Hash 
+        #
+        # @param [Hash] hash 
+        #   Optional fields to assign to object
+        #
+        def initialize( hash = {} ) 
+            $log.debug( "Profile init with hash = #{hash.inspect}")
+            default_values = {
+                'provider'       => 'publisher',
+                'email'          => '',
+                'first_name'     => '', 
+                'last_name'      => '',
+                'display_name'   => '',
+                'profile_photo'  => '',
+            }
+            default_values.merge!( hash )
+            $log.debug( "Profile default_values = #{default_values.inspect}")
+            super( default_values )
+        end
+    end
+end

data/lib/big_door/resource.rb

@@ -0,0 +1,204 @@
+require 'ostruct'
+require 'logger'
+
+module BigDoor
+    class Resource < OpenStruct
+        ##
+        # 
+        # This class provides base class for Resource objects 
+        #
+        
+
+        ##
+        # Initialize new Resource object with optional Hash 
+        #
+        # @param [Hash] hash 
+        #   Optional fields to assign to object
+        #
+        def initialize( hash = {}) 
+            $log.debug( "Resource init with hash = #{hash.inspect}")
+            default_values = {
+                'pub_title'            => '',
+                'pub_description'      => '',
+                'end_user_title'       => '',
+                'end_user_description' => '',
+            }
+            default_values.merge!( hash )
+            $log.debug( "Resource default_values = #{default_values.inspect}")
+
+            if default_values.key?('id')
+                default_values['resource_id'] = default_values['id']
+                default_values.delete('id')
+            end
+            super( default_values )
+        end
+
+        ##
+        # Derieve API end point form Class name
+        #
+        #  @param [String] Class name
+        #
+        #  @return [String] resource name
+        #
+        def self.end_point_from_classname( name )
+            # FIXME should fail if name = Resource
+            $log.debug("end_point_from_classname called with name = #{name}")
+            if name =~ /BigDoor::(.+)$/
+                resource_name = $1
+
+                $log.debug("resource_name = #{resource_name}")
+
+                resource_name.gsub!(/([A-Z]+)([A-Z][a-z])/, '\1_\2');
+                resource_name.gsub!(/([a-z\d])([A-Z])/, '\1_\2');
+                # FIXME if no match
+                resource_name.downcase!
+
+            else
+                # FIXME if no match
+            end
+            $log.debug("resource_name = #{resource_name}")
+            resource_name
+        end
+
+        ##
+        # Derieve API end point form Class name
+        #
+        #  @return [String] resource name
+        #
+        def end_point
+            Resource.end_point_from_classname( self.class.name )
+        end
+        
+        ##
+        # Derieve API end point form Class name
+        #
+        #  @return [String] resource name
+        #
+        def self.end_point
+            end_point_from_classname( self.name )
+        end
+
+        ##
+        # Get Resource id for Resource Object. To be overriden in child classes.
+        #
+        #  @return [String] resource ID
+        #
+        def get_id 
+            self.resource_id
+        end
+
+        ##
+        # Convert object content to Hash
+        #
+        # @return [Hash] Object fields 
+        #
+        def instance_to_payload
+            payload = {}
+            @table.each do |key, value|
+                payload[key] = value
+            end
+            payload
+        end
+
+        ##
+        # Sets object fields to values from response Hash
+        #
+        #  @param [Hash] response
+        #    Hash representing decoded JSON response from API
+        #
+        #  @return nothing  
+        #
+        def response_to_instance( response )
+            $log.debug('update instance from response')
+            response.each do |key, value|
+                key = 'resource_id' if key == 'id' 
+                self.instance_eval("self.#{key} = \'#{value}\'")
+                $log.debug(sprintf "%s = %s", key, self.instance_eval("self.#{key}") )
+            end
+        end
+
+        ##
+        # Saves Resource object. If object has +id+ attribute defined than
+        # +PUT+ method is used, otherwise +POST+ is used.
+        #
+        #  @param [BigDoor::Client] client
+        #    Initialized BigDoor::Client object
+        #
+        #  @return nothing
+        #
+        def save( client )
+            uri = end_point
+            $log.debug( "end_point = #{uri}")
+            payload = instance_to_payload
+            if payload.key?(:resource_id)
+                $log.debug('PUT');
+                response = client.put( sprintf("%s/%s", uri, self.get_id ), { 'format' => 'json' }, payload )
+            else
+                $log.debug('POST');
+                response = client.post( "#{uri}", { 'format' => 'json' }, payload )
+            end
+            response_to_instance( response )
+        end
+
+        ##
+        # Loads Resource object identified by optional ID parameter or by
+        # object own resource_id
+        #
+        #  @param [BigDoor::Client] client
+        #    Initialized BigDoor::Client object
+        #
+        #  @param [String] id
+        #    Object resource ID
+        #
+        #  @return nothing
+        #
+        def load( client, id = nil) 
+            id = self.get_id unless id
+            raise ArgumentError.new('Pass id as param or set resource_id for object ') unless id
+            $log.debug('GET');
+            response = client.get( sprintf("%s/%s", end_point, id), { 'format' => 'json' })
+            response_to_instance( response )
+        end
+
+        ##
+        # Deletes Resource object identified by optional ID parameter or by
+        # object own resource_id
+        #
+        #  @param [BigDoor::Client] client
+        #    Initialized BigDoor::Client object
+        #
+        #  @param [String] id
+        #    Object resource ID
+        #
+        #  @return nothing
+        #
+        def delete( client, id = nil)
+            # FIXME if id defined - should use class method
+            id = self.resource_id unless id
+            # FIXME if no id defined
+            client.delete( (sprintf "%s/%s", end_point, id), { 'format' => 'json' })
+            self.resource_id = nil
+        end
+
+        ##
+        # Loads all Resource objects by this type
+        #
+        #  @param [BigDoor::Client] client
+        #    Initialized BigDoor::Client object
+        #
+        #  @return [Array] Array of BigDoor::Resource derieved objects
+        #
+        def self.all( client )
+            uri = end_point
+            $log.debug( "end_point = #{uri}")
+            response = client.get( uri, { 'format' => 'json' } )
+            $log.debug( "response to all = #{response}")
+            allobj = response.map{ |obj| 
+                $log.debug("obj = #{obj.inspect}")
+                self.new(obj) 
+            }
+            $log.debug( "allobj = #{allobj.inspect}")
+            allobj
+        end
+    end
+end

data/lib/big_door/resource_end_user.rb

@@ -0,0 +1,84 @@
+module BigDoor
+
+    #
+    # This module provides Resource class with EndUser Parent
+    #
+    
+    class ResourceEndUser < Resource
+        ##
+        # Calculates Resource object API end point from its class name using
+        # parent_end_point and parent_id_attr (possibly overriden in child classes)
+        #
+        def end_point
+            $log.debug("parent_end_point = #{ResourceEndUser.parent_end_point}")
+            $log.debug("parent_id_attr = #{parent_id_attr}")
+            $log.debug("parent_id_attr value = #{self.instance_eval("self.#{parent_id_attr}")}")
+
+            # FIXME if parent_id_attr empty
+            # FIXME if no self.#{parent_id_attr}
+            ep = sprintf "%s/%s/%s", 
+                ResourceEndUser.parent_end_point,
+                self.instance_eval("self.#{parent_id_attr}"),
+                Resource.end_point_from_classname( self.class.name )
+            ep
+        end
+
+        ##
+        # Calculates Resource object API end point from its class name using
+        # parent_end_point and parent_id_attr (possibly overriden in child classes)
+        #
+        def self.end_point( username )
+            # FIXME code duplication
+            $log.debug("parent_end_point = #{ResourceEndUser.parent_end_point}")
+
+            # FIXME if parent_id_attr empty
+            # FIXME if no self.#{parent_id_attr}
+            ep = sprintf "%s/%s/%s", 
+                ResourceEndUser.parent_end_point,
+                username,
+                Resource.end_point_from_classname( self.name )
+            ep
+        end
+        
+        ##
+        # Loads all Resource objects by this type
+        #
+        #  @param [String] username
+        #    end_user_login to be used as base API end point
+        #
+        #  @param [BigDoor::Client] client
+        #    Initialized BigDoor::Client object
+        #
+        #  @return [Array] Array of BigDoor::Resource derieved objects
+        #
+        def self.all( username, client )
+            # FIXME code duplication
+            uri = self.end_point( username )
+            $log.debug( "end_point = #{uri}")
+            response = client.get( uri, { 'format' => 'json' } )
+            $log.debug( "response to all = #{response}")
+            allobj = response.map{ |obj| 
+                $log.debug("obj = #{obj.inspect}")
+                self.new(obj) 
+            }
+            $log.debug( "allobj = #{allobj.inspect}")
+            allobj
+        end
+
+        ##
+        # Gives default base parent_end_point for object. 
+        # Can be overriden in inherited classes.
+        #
+        def self.parent_end_point 
+            'end_user'
+        end
+
+        ##
+        # Gives default parent_id attribute name for object.
+        # Can be overriden in inherited classes.
+        # 
+        def parent_id_attr
+            'end_user_login'
+        end
+    end
+end

data/lib/big_door/resource_with_association.rb

@@ -0,0 +1,37 @@
+module BigDoor
+
+    #
+    # This module provides Resource class with Association
+    #
+    
+    class ResourceWithAssociation < Resource
+        ##
+        # Assocaiate this Resource with another Resource
+        #
+        #  @param [BigDoor::Resource] resource
+        #    Resource to be associated with. See BigDoor documentation for list
+        #    of objects which allow association
+        #
+        #  @param [BigDoor::Client] client
+        #    Initialized BigDoor::Client object
+        #
+        #  @param [Hash] payload
+        #    Hash to be converted to HTTP POST form-url-encoded body
+        #
+        #  @return [Hash] Decoded JSON response if any
+        #  
+        def associate_with(resource, client, payload = {})
+            $log.debug('associate_with');
+
+            uri = sprintf '%s/%s/%s/%s', 
+                end_point, 
+                self.resource_id, 
+                resource.resource_name, 
+                resource.resource_id
+
+            $log.debug( sprintf 'uri = %s', uri )
+            result = client.post( uri , { 'format' => 'json'}, payload )
+            $log.debug(sprintf 'result = %s', result.inspect );
+        end
+    end
+end

data/lib/big_door/resource_with_parent.rb

@@ -0,0 +1,43 @@
+module BigDoor
+
+    #
+    # This module provides Resource class with Parent
+    #
+    
+    class ResourceWithParent < Resource
+        ##
+        # Calculates Resource object API end point from its class name using
+        # parent_end_point and parent_id_attr (possibly overriden in child classes)
+        #
+        def end_point
+            $log.debug("parent_end_point = #{parent_end_point}")
+            $log.debug("parent_id_attr = #{parent_id_attr}")
+            $log.debug("parent_id_attr value = #{self.instance_eval("self.#{parent_id_attr}")}")
+
+            # FIXME if parent_id_attr empty
+            # FIXME if no self.#{parent_id_attr}
+            ep = sprintf "%s/%s/%s", 
+                parent_end_point,
+                self.instance_eval("self.#{parent_id_attr}"),
+                Resource.end_point_from_classname( self.class.name )
+            ep
+        end
+
+        ##
+        # Gives default base parent_end_point for object. 
+        # Can be overriden in inherited classes.
+        #
+        def parent_end_point 
+            resource_name = Resource.end_point_from_classname( self.class.name )
+            "#{resource_name}_collection"
+        end
+
+        ##
+        # Gives default parent_id attribute name for object.
+        # Can be overriden in inherited classes.
+        # 
+        def parent_id_attr
+            "#{parent_end_point}_id"
+        end
+    end
+end

data/lib/big_door/url.rb

@@ -0,0 +1,21 @@
+module BigDoor
+    #
+    # This module provides URL Resource object 
+    # corresponding to /url BigDoor API end point
+    #
+    class URL < ResourceWithAssociation
+        ##
+        # Initialize new URL object with optional Hash 
+        #
+        # @param [Hash] hash 
+        #   Optional fields to assign to object
+        #
+        def initialize( hash = {} ) 
+            $log.debug( "URL init with hash = #{hash.inspect}")
+            default_values = { }
+            default_values.merge!( hash )
+            $log.debug( "URL default_values = #{default_values.inspect}")
+            super( default_values )
+        end
+    end
+end

data/lib/big_door.rb

@@ -0,0 +1,40 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require 'big_door/client'
+require 'big_door/resource'
+require 'big_door/resource_with_association'
+require 'big_door/resource_with_parent'
+require 'big_door/resource_end_user'
+
+require 'big_door/attribute'
+require 'big_door/award'
+require 'big_door/currency'  
+require 'big_door/currency_balance'
+require 'big_door/currency_type'
+require 'big_door/end_user'
+require 'big_door/good'
+require 'big_door/leaderboard'
+require 'big_door/level'
+require 'big_door/named_award'
+require 'big_door/named_award_collection'
+require 'big_door/named_good'
+require 'big_door/named_good_collection'
+require 'big_door/named_level'
+require 'big_door/named_level_collection'
+require 'big_door/named_transaction'
+require 'big_door/named_transaction_group'
+require 'big_door/profile'
+require 'big_door/url'
+
+$log =  ENV['BIGDOOR_DEBUG'] ? Logger.new('debug.log') : Logger.new( STDERR )
+$log.level = ENV['BIGDOOR_DEBUG'] ? Logger::DEBUG : Logger::ERROR
+
+$log.datetime_format = "%Y-%m-%d %H:%M:%S "
+$log.debug( '=======================')
+$log.debug( $log.datetime_format)
+
+
+module BigDoor
+  VERSION = '0.0.1'
+end

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/bigdoorkit.rb'}"
+puts "Loading bigdoorkit gem"
+exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/spec/big_door/attribute_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+module BigDoor 
+    describe Attribute do
+        before(:each) do
+            @client = BigDoor::Client.new( TEST_APP_SECRET, TEST_APP_KEY )
+        end
+        context "Attribute class" do
+            it "Should respond to :all" do 
+                BigDoor::Attribute.should respond_to(:all).with(1).arguments
+            end
+            it "Should load Array of Attributes at the beginning" do
+                currency_types = BigDoor::Attribute.all( @client )
+                currency_types.should be_a_instance_of( Array )
+            end
+        end
+    end
+end

data/spec/big_door/award_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+module BigDoor 
+    describe Award do
+        before(:each) do
+            @client = BigDoor::Client.new( TEST_APP_SECRET, TEST_APP_KEY )
+        end
+        context "fresh Award object" do 
+            subject { BigDoor::Award.new  }
+            it { should be }
+            it { should be_a_instance_of( BigDoor::Award )}
+        end
+        context "Award class" do
+            it "Should respond to :all" do 
+                BigDoor::Award.should respond_to(:all).with(2).arguments
+            end
+        end
+    end
+end