big_door 0.0.1

data/lib/big_door/client.rb

@@ -0,0 +1,281 @@
+require 'restclient'
+require 'addressable/uri'
+require 'json'
+require 'digest/sha1'
+require 'uuidtools'
+
+module BigDoor
+    #
+    # This module provides interface to BigDoor public REST API
+    #
+    DEFAULT_APP_HOST = 'http://api.bigdoor.com'
+
+    class Client
+        ##
+        # This class provides low-level interface to BigDoor public REST API
+        #
+        attr_accessor :app_key
+        attr_accessor :app_secret
+        attr_accessor :app_host
+
+        ##
+        # Creates new BigDoor::Client object
+        #
+        # @param [String] app_secret
+        #   The API secret supplied by BigDoor. (see API Keys http://publisher.bigdoor.com/)
+        #
+        # @param [String] app_key
+        #   The API key supplied by BigDoor. (see API Keys http://publisher.bigdoor.com/)
+        #
+        # @param [String] app_host  
+        #   An alternative host to enable use with testing servers.
+        #
+        def initialize( app_secret, app_key, app_host = DEFAULT_APP_HOST )
+            @app_key = app_key
+            @app_secret = app_secret
+            @app_host = app_host
+
+            @base_url = "/api/publisher/#{@app_key}"
+        end
+
+        ##
+        # Converts params hash to string
+        #
+        # @param params 
+        #   Hash representing request params, except +sig+ and +format+ fields
+        # 
+        # @return [String] Request params concatanated 
+        #
+        def flatten_params( params )
+            raise ArgumentError.new('params should be defined') unless params
+            result = ''
+            keys = params.keys.sort{|a,b| a.to_s <=> b.to_s}
+            keys.each do |key| 
+                next if key == 'sig' 
+                next if key == 'format'
+                result += "#{key}#{params[key]}"
+            end
+            $log.debug(sprintf "flatten_params = %s", result )
+            result
+        end
+
+        ##
+        #  Generate appropriate request signature given a url and optional
+        #  params and payload.
+        #
+        #  @param [String] url
+        #    The full URL, including the base /api/publisher/[app_key]
+        #
+        #  @param [Hash] params  
+        #    The parameters to be sent via the query string.
+        #
+        #  @param [Hash] payload
+        #    The parameters to be sent via the PUT or POST request body.
+        #
+        #  @return [String] request signature to be sent as +sign+ query param
+        #    
+        def generate_signature( url, params = nil, payload = nil )
+            signature = url
+            signature += flatten_params( params ) if params
+            signature += flatten_params( payload ) if payload 
+            signature += @app_secret
+
+            $log.debug(sprintf "signature = %s", signature )
+
+            Digest::SHA256.hexdigest(signature)
+        end
+
+        ##
+        # Generate random token for request
+        #
+        #  @return [String] Random token to be sent as +token+ 
+        def generate_token
+            UUIDTools::UUID.random_create.hexdigest
+        end
+
+        ##
+        # Add requered fields to params and payload
+        #
+        #  @param [Symbol] method 
+        #    HTTP request method
+        #
+        #  @param [Hash] params  
+        #    The parameters to be sent via the query string.
+        #
+        #  @param [Hash] payload
+        #    The parameters to be sent via the PUT or POST request body.
+        #
+        #  @return [Hash, Hash] Updated params and payload
+        #
+        def add_required_params( method, params, payload )
+            raise ArgumentError.new('unkown method') unless [:get, :put, :post, :delete].include?(method)
+
+            params = {} unless params
+            payload = {} unless payload
+            
+            is_postish = [:post, :put].include?(method)
+
+            if is_postish && payload.key?('time')
+                params['time'] = payload['time']
+            end
+            if params && !params.key?('time')
+                params['time'] = Time.now.to_i.to_s
+            end
+            if is_postish && !payload.key?('time')
+                payload['time'] = params['time']
+            end
+
+            if is_postish && !payload.key?('token')
+                payload['token'] = self.generate_token
+            end
+            
+            if method == :delete && !params.key?('delete_token') 
+                params['delete_token'] = self.generate_token
+            end
+
+            [params, payload]
+        end
+
+        ##
+        # Sign request
+        #
+        #  @param [Symbol] method 
+        #    HTTP request method
+        #
+        #  @param [String] url 
+        #    HTTP request URL
+        #
+        #  @param [Hash] params  
+        #    The parameters to be sent via the query string.
+        #
+        #  @param [Hash] payload
+        #    The parameters to be sent via the PUT or POST request body.
+        #
+        #  @return [Hash, Hash] Updated params and payload 
+        #
+        def sign_request( method, url, params, payload )
+
+            params, payload = add_required_params( method, params, payload )
+
+            params['sig'] = self.generate_signature( url, params, payload )
+            
+            [params, payload]
+        end
+
+        ##
+        # Makes GET HTTP request to API with optional params
+        #
+        #  @param [String] url 
+        #    relative API end point (eg. currency_type/1 )
+        #
+        #  @param [Hash] params
+        #    The parameters to be sent via the query string.
+        #
+        #  @return [Hash] Decoded JSON response
+        #
+        def get( url, params = nil)
+            do_request( :get, url, params)
+        end
+
+        ##
+        # Makes POST HTTP request to API with optional params and
+        # www-form-urlencoded payload
+        #
+        #  @param [String] url 
+        #    relative API end point (eg. currency_type )
+        #
+        #  @param [Hash] params
+        #    The parameters to be sent via the query string.
+        #
+        #  @param [Hash] payload
+        #    The parameters to be sent via the PUT or POST request body.
+        #
+        #  @return [Hash] Decoded JSON response
+        #
+        def post( url, params, payload )
+            do_request( :post, url, params, payload)
+        end
+
+        ##
+        # Makes PUT HTTP request to API with optional params and
+        # www-form-urlencoded payload
+        #
+        #  @param [String] url 
+        #    relative API end point (eg. currency/12345 )
+        #
+        #  @param [Hash] params
+        #    The parameters to be sent via the query string.
+        #
+        #  @param [Hash] payload
+        #    The parameters to be sent via the PUT or POST request body.
+        #
+        #  @return [Hash] Decoded JSON response
+        #
+        def put( url, params, payload  )
+            do_request( :put, url, params, payload)
+        end
+
+        ##
+        # Makes DELETE HTTP request to API with optional params
+        #
+        #  @param [String] url 
+        #    relative API end point (eg. currency/12345 )
+        #
+        #  @param [Hash] params
+        #    The parameters to be sent via the query string.
+        #
+        #  @return [String] should return empty string in case of success
+        #
+        def delete( url, params = nil)
+            do_request( :delete, url, params)
+        end
+
+        ##
+        # Makes HTTP request to API with optional params and 
+        # www-form-urlencoded payload
+        #
+        #   @param [Symbol] method 
+        #     HTTP request method
+        #
+        #  @param [String] url 
+        #    relative API end point (eg. currency/12345 )
+        #
+        #  @param [Hash] params
+        #    The parameters to be sent via the query string.
+        #
+        #  @param [Hash] payload
+        #    The parameters to be sent via the PUT or POST request body.
+        #
+        #  @return [Hash] Decoded JSON response or empty/undefined string
+        #
+        def do_request( method, end_point, params = nil, payload = nil )
+            headers = {
+                'User-Agent' => "BigDoorKit-Ruby/#{VERSION}",
+            }
+            
+            if [:post, :put].include?(method)
+                headers['Content-Type'] = 'application/x-www-form-urlencoded'
+            end
+
+            params, payload = sign_request( method, @base_url + '/' + end_point, params, payload )
+
+            url = Addressable::URI.parse( @app_host + @base_url + '/' + end_point )
+            $log.debug( sprintf 'url  object = %s', url.inspect )
+            $log.debug( sprintf 'params = %s', params.inspect )
+            url.query_values = params
+
+            $log.debug( sprintf 'method url = %s %s', method, url )
+            $log.debug( sprintf 'payload = %s', payload.inspect )
+            
+            response = RestClient::Request.execute(:method => method, :url => url.to_s, :payload => payload, :headers => headers, :raw_response => false)
+            if response && !response.empty?
+                $log.debug( sprintf 'undecoded_response = %s', response.inspect )
+                decoded_response = JSON.parse( response )
+                $log.debug( sprintf 'decoded_response = %s', decoded_response.inspect )
+                decoded_response[0]
+            end
+        rescue RestClient::Exception => ex
+            $log.debug(sprintf 'Error response body: %s', ex.http_body)
+        end
+    end
+end

data/lib/big_door/currency.rb

@@ -0,0 +1,26 @@
+module BigDoor
+    #
+    # This module provides Currency Resource object 
+    # corresponding to /currency BigDoor API end point
+    #
+    class Currency < Resource
+        ##
+        # Initialize new Currency object with optional Hash 
+        #
+        # @param [Hash] hash 
+        #   Optional fields to assign to object
+        #
+        def initialize( hash = {} ) 
+            $log.debug( "Currency init with hash = #{hash.inspect}")
+            default_values = {
+                'currency_type_id' => 1,
+                'currency_type_title' => '',
+                'exchange_rate' => 1,
+                'relative_weight' => 1,
+            }
+            default_values.merge!( hash )
+            $log.debug( "Currency default_values = #{default_values.inspect}")
+            super( default_values )
+        end
+    end
+end

data/lib/big_door/currency_balance.rb

@@ -0,0 +1,27 @@
+module BigDoor
+    #
+    # This module provides CurrencyBalance Resource object 
+    # corresponding to /end_user/{id}/currency_balance BigDoor API end point
+    #
+    class CurrencyBalance < ResourceEndUser
+        ##
+        # Initialize new CurrencyBalance object with optional Hash 
+        #
+        # @param [Hash] hash 
+        #   Optional fields to assign to object
+        #
+        def initialize( hash = {} ) 
+            $log.debug( "CurrencyBalance init with hash = #{hash.inspect}")
+            default_values = {
+                'read_only'            => 0,
+                'adjustment_amount'    => 0,
+                'curr_balance'         => 0,
+                'prev_balance'         => 0,
+                'transaction_group_id' => nil,
+            }
+            default_values.merge!( hash )
+            $log.debug( "CurrencyBalance default_values = #{default_values.inspect}")
+            super( default_values )
+        end
+    end
+end

data/lib/big_door/currency_type.rb

@@ -0,0 +1,29 @@
+module BigDoor
+    #
+    # This module provides CurrencyType Resource object 
+    # corresponding to /currency_type BigDoor API end point
+    #
+    class CurrencyType < Resource
+        ##
+        # Initialize new CurrencyType object with optional Hash 
+        #
+        # @param [Hash] hash 
+        #   Optional fields to assign to object
+        #
+        def initialize( hash = {} ) 
+            $log.debug( "CurrencyType init with hash = #{hash.inspect}")
+            default_values = {
+                'read_only'                          => 1,
+                'title'                              => '',
+                'description'                        => '',
+                'has_dollar_exchange_rate_integrity' => 0,
+                'can_be_cross_publisher'             => 0,
+                'can_be_purchased'                   => 0,
+                'can_be_rewarded'                    => 0,
+            }
+            default_values.merge!( hash )
+            $log.debug( "CurrencyType default_values = #{default_values.inspect}")
+            super( default_values )
+        end
+    end
+end

data/lib/big_door/end_user.rb

@@ -0,0 +1,32 @@
+module BigDoor
+    #
+    # This module provides EndUser Resource object 
+    # corresponding to /end_user BigDoor API end point
+    #
+    class EndUser < Resource
+
+        ##
+        # Initialize new EndUser object with optional Hash 
+        #
+        # @param [Hash] hash 
+        #   Optional fields to assign to object
+        #
+        def initialize( hash = {} ) 
+            $log.debug( "EndUser init with hash = #{hash.inspect}")
+            default_values = {
+                'end_user_login'          => '',
+            }
+            default_values.merge!( hash )
+            $log.debug( "EndUser default_values = #{default_values.inspect}")
+            super( default_values )
+        end
+
+        ##
+        # Overrides object resource id 
+        #
+        # @return [String] resource id
+        def resource_id
+            self.end_user_login
+        end
+    end
+end

data/lib/big_door/good.rb

@@ -0,0 +1,32 @@
+module BigDoor
+    #
+    # This module provides Good Resource object 
+    # corresponding to /end_user/{id}/good BigDoor API end point
+    #
+    class Good < ResourceEndUser
+        ##
+        # Initialize new Good object with optional Hash 
+        #
+        # @param [Hash] hash 
+        #   Optional fields to assign to object
+        #
+        def initialize( hash = {} ) 
+            $log.debug( "Good init with hash = #{hash.inspect}")
+            default_values = {
+                'named_good_id' => nil,
+            }
+            default_values.merge!( hash )
+            $log.debug( "Good default_values = #{default_values.inspect}")
+            super( default_values )
+        end
+
+        ##
+        # Override parent_id_attr from ResourceEndUser Class
+        #
+        #  @return [String] Parent Id attribute
+        #
+        def parent_id_attr
+            'good_receiver'
+        end
+    end
+end

data/lib/big_door/leaderboard.rb

@@ -0,0 +1,41 @@
+module BigDoor
+    #
+    # This module provides Leaderboard Resource object 
+    # corresponding to /leaderboard BigDoor API end point
+    #
+    class Leaderboard < Resource
+        ##
+        # Initialize new Leaderboard object with optional Hash 
+        #
+        # @param [Hash] hash 
+        #   Optional fields to assign to object
+        #
+        def initialize( hash = {} ) 
+            $log.debug( "Leaderboard init with hash = #{hash.inspect}")
+            default_values = { }
+            default_values.merge!( hash )
+            $log.debug( "Leaderboard default_values = #{default_values.inspect}")
+            super( default_values )
+        end
+        ##
+        # Executes Leaderboard retrieval
+        #
+        #  @param [Hash] params
+        #    request params
+        #
+        #  @param [BigDoor::Client] client
+        #    Initialized BigDoor::Client object
+        #
+        #  @return [Array] array of Hashes representing Leaderboard
+        #
+        def execute( params, client )
+            $log.debug('execute leaderboard');
+
+            uri = sprintf '%s/execute', end_point
+
+            $log.debug( sprintf 'execute uri = %s', uri )
+            result = client.get( uri , params )
+            $log.debug(sprintf 'result = %s', result.inspect );
+        end
+    end
+end

data/lib/big_door/level.rb

@@ -0,0 +1,25 @@
+module BigDoor
+    #
+    # This module provides Level Resource object 
+    # corresponding to /end_user/{id}/level BigDoor API end point
+    #
+    class Level < ResourceEndUser
+        ##
+        # Initialize new Level object with optional Hash 
+        #
+        # @param [Hash] hash 
+        #   Optional fields to assign to object
+        #
+        def initialize( hash = {} ) 
+            $log.debug( "Level init with hash = #{hash.inspect}")
+            default_values = {
+                'transaction_group_id' => 0,
+                'end_user_login'       => nil,
+                'named_level_id'       => nil,
+            }
+            default_values.merge!( hash )
+            $log.debug( "Level default_values = #{default_values.inspect}")
+            super( default_values )
+        end
+    end
+end

data/lib/big_door/named_award.rb

@@ -0,0 +1,24 @@
+module BigDoor
+    #
+    # This module provides NamedAward Resource object 
+    # corresponding to /named_award BigDoor API end point
+    #
+    class NamedAward < ResourceWithParent
+        ##
+        # Initialize new NamedAward object with optional Hash 
+        #
+        # @param [Hash] hash 
+        #   Optional fields to assign to object
+        #
+        def initialize( hash = {} ) 
+            $log.debug( "NamedAward init with hash = #{hash.inspect}")
+            default_values = {
+                'named_award_collection_id'          => nil,
+                'relative_weight'                    => 0,
+            }
+            default_values.merge!( hash )
+            $log.debug( "NamedAward default_values = #{default_values.inspect}")
+            super( default_values )
+        end
+    end
+end

data/lib/big_door/named_award_collection.rb

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

data/lib/big_door/named_good.rb

@@ -0,0 +1,24 @@
+module BigDoor
+    #
+    # This module provides NamedGood Resource object 
+    # corresponding to /named_good BigDoor API end point
+    #
+    class NamedGood < ResourceWithParent
+        ##
+        # Initialize new NamedGood object with optional Hash 
+        #
+        # @param [Hash] hash 
+        #   Optional fields to assign to object
+        #
+        def initialize( hash = {} ) 
+            $log.debug( "NamedGood init with hash = #{hash.inspect}")
+            default_values = {
+                'named_good_collection_id'           => nil,
+                'relative_weight'                    => 0,
+            }
+            default_values.merge!( hash )
+            $log.debug( "NamedGood default_values = #{default_values.inspect}")
+            super( default_values )
+        end
+    end
+end

data/lib/big_door/named_good_collection.rb

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

data/lib/big_door/named_level.rb

@@ -0,0 +1,26 @@
+module BigDoor
+    #
+    # This module provides NamedLevel Resource object 
+    # corresponding to /named_level BigDoor API end point
+    #
+    class NamedLevel < ResourceWithParent
+        ##
+        # Initialize new NamedLevel object with optional Hash 
+        #
+        # @param [Hash] hash 
+        #   Optional fields to assign to object
+        #
+        def initialize( hash = {} ) 
+            $log.debug( "NamedLevel init with hash = #{hash.inspect}")
+            default_values = {
+                'named_level_collection_id'          => nil,
+                'relative_weight'                    => 0,
+                'threshold'                          => 0,
+            }
+            default_values.merge!( hash )
+            $log.debug( "NamedLevel default_values = #{default_values.inspect}")
+            super( default_values )
+        end
+
+    end
+end

data/lib/big_door/named_level_collection.rb

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

data/lib/big_door/named_transaction.rb

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