big_door 0.0.1

data/features/resources/named_level_collection.feature

@@ -0,0 +1,44 @@
+@passing
+Feature: named_level_collection API endpoint
+
+    In order to operate with named level collections
+    As object-oriented API client user
+    I want to use NamedLevelCollection object
+
+    @local
+    Scenario: get list of all NamedLevelCollections
+        Given low-level client
+        When I call it to list all "NamedLevelCollection" objects
+        Then I should get list of "NamedLevelCollection" objects
+
+    @local
+    Scenario: create a new NamedLevelCollection
+        Given low-level client
+        When I create a new "NamedLevelCollection" object
+        Then I should get a "NamedLevelCollection" object
+    
+    @remote
+    Scenario: create and save a new NamedLevelCollection
+        Given low-level client
+        And some Currency
+        When I create a new "NamedLevelCollection" object
+        And assign some NamedLevelCollection data to object
+        And save object
+        Then I should get a "NamedLevelCollection" object
+        And object should has resource_id defined
+        And I should be able to remove object
+        And Currency should be removed
+    
+    @remote
+    Scenario: add NamedLevel to NamedLevelCollection 
+        Given low-level client
+        And some Currency
+        And new empty NamedLevelCollection
+        When I create a new "NamedLevel" object
+        And assign NamedLevel data to object
+        And save object
+        Then I should get a "NamedLevel" object
+        And object should has resource_id defined
+        And I should be able to remove object
+        And collection should be removed too
+        And Currency should be removed

data/features/resources/url.feature

@@ -0,0 +1,41 @@
+@passing
+Feature: url API endpoint
+
+    In order to operate with url objects
+    As object-oriented API client user
+    I want to use URL object
+
+    @remote 
+    Scenario: get list of all URL
+        Given low-level client
+        When I call it to list all "URL" objects
+        Then I should get list of "URL" objects
+
+    @local
+    Scenario: create a new URL
+        Given low-level client
+        When I create a new "URL" object
+        Then I should get a "URL" object
+    
+    @remote
+    Scenario: create and save a new URL
+        Given low-level client
+        When I create a new "URL" object
+        And assign "URL" data to object
+        And save object
+        Then I should get a "URL" object
+        And object should has resource_id defined
+        And I should be able to remove object
+    
+    @remote
+    Scenario: create, save and associate a new URL
+        Given low-level client
+        And some Currency
+        When I create a new "URL" object
+        And assign "URL" data to object
+        And save object
+        And associate "URL" with "Currency"
+        Then I should get a "URL" object
+        And object should has resource_id defined
+        And I should be able to remove object
+        And Currency should be removed

data/features/step_definitions/resources_steps.rb

@@ -0,0 +1,370 @@
+
+Given /^low\-level client$/ do
+      @client = BigDoor::Client.new( TEST_APP_SECRET, TEST_APP_KEY )
+end
+
+Given /^new empty "NamedAwardCollection" collection$/ do
+    @collection = BigDoor::NamedAwardCollection.new
+    @collection.pub_title            = 'application achievements'
+    @collection.pub_description      = 'a set of achievements that the user can earn'
+    @collection.end_user_title       = 'achievements'
+    @collection.end_user_description = 'things you can get'
+    @collection.save( @client )
+end
+
+Given /^new empty NamedGoodCollection$/ do
+    @collection = BigDoor::NamedGoodCollection.new
+    @collection.pub_title            = 'Test Named Good Collection'
+    @collection.pub_description      = 'test description'
+    @collection.end_user_title       = 'test user title'
+    @collection.end_user_description = 'test user description'
+    @collection.save( @client )
+end
+
+Given /^new empty NamedLevelCollection$/ do
+    @collection = BigDoor::NamedLevelCollection.new({
+        'pub_title'            => 'Test Named Level Collection',
+        'pub_description'      => 'test description',
+        'end_user_title'       => 'test user title',
+        'end_user_description' => 'test user description',
+        'currency_id'          =>  @currency.resource_id,
+    })
+
+    @collection.save( @client )
+end
+
+Given /^some Currency$/ do
+    @currency = BigDoor::Currency.new({
+        'pub_title'            => 'Coins',
+        'pub_description'      => 'an example of the Purchase currency type',
+        'end_user_title'       => 'Coins',
+        'end_user_description' => 'can only be purchased',
+        'currency_type_id'     => '1',
+        'currency_type_title'  => 'Purchase',
+        'exchange_rate'        => 900.00,
+        'relative_weight'      => 2,
+    })
+    @currency.save( @client )
+end
+
+When /^I call it to list all "(\w+)" objects$/ do |class_name| 
+    eval(" @list_all = BigDoor::#{class_name}.all( @client ) ")
+end
+
+When /^I call it to list all "(\w+)" objects from "EndUser"$/ do |class_name| 
+    eval(" @list_all = BigDoor::#{class_name}.all( @username, @client ) ")
+end
+
+When /^I create a new "(\w+)" object$/ do |class_name|
+    eval(" @object = BigDoor::#{class_name}.new")
+end
+
+When /^assign some NamedAwardCollection data to object$/ do
+    @object.pub_title            = 'application achievements'
+    @object.pub_description      = 'a set of achievements that the user can earn'
+    @object.end_user_title       = 'achievements'
+    @object.end_user_description = 'things you can get'
+end
+
+When /^assign some NamedGoodCollection data to object$/ do
+    @object.pub_title            = 'Test Named Good Collection title'
+    @object.pub_description      = 'test named good collection description'
+    @object.end_user_title       = 'test named good collection end user title'
+    @object.end_user_description = 'test named good collection end user description'
+end
+
+When /^assign some NamedLevelCollection data to object$/ do
+    @object.pub_title            = 'Test Named Level Collection title'
+    @object.pub_description      = 'test named Level collection description'
+    @object.end_user_title       = 'test named Level collection end user title'
+    @object.end_user_description = 'test named Level collection end user description'
+    @object.currency_id          = @currency.resource_id
+end
+
+When /^assign NamedAward data to object$/ do
+    @object.pub_title                 = 'obligatory early achievement '
+    @object.pub_description           = 'the sort of achievement you get when you can turn on an xbox'
+    @object.end_user_title            = 'just breath'
+    @object.end_user_description      = 'congratulations you rock so hard; keep on breathing'
+    @object.relative_weight           = 1
+    @object.named_award_collection_id = @collection.resource_id
+end
+
+When /^assign NamedGood data to object$/ do
+    @object.pub_title                 = 'Named Good pub title'
+    @object.pub_description           = 'Named Good pub description'
+    @object.end_user_title            = 'Named Good end user title'
+    @object.end_user_description      = 'Named Good end user description'
+    @object.relative_weight           = 1
+    @object.named_good_collection_id = @collection.resource_id
+end
+
+When /^assign NamedLevel data to object$/ do
+    @object.pub_title                 = 'Named Level pub title'
+    @object.pub_description           = 'Named Level pub description'
+    @object.end_user_title            = 'Named Level end user title'
+    @object.end_user_description      = 'Named Level end user description'
+#    @object.relative_weight           = 1
+#    @object.threshold                 = 100
+    @object.named_level_collection_id = @collection.resource_id
+end
+
+When /^assign "Attribute" data to object$/ do
+    @object.pub_title                 = 'Attribute pub title'
+    @object.pub_description           = 'Attribute pub description'
+    @object.end_user_title            = 'Attribute end user title'
+    @object.end_user_description      = 'Attribute end user description'
+end
+
+When /^assign "URL" data to object$/ do
+    @object.pub_title                 = 'URL pub title'
+    @object.pub_description           = 'URL pub description'
+    @object.end_user_title            = 'URL end user title'
+    @object.end_user_description      = 'URL end user description'
+    @object.url                       = 'http://example.org'
+end
+
+When /^associate "([^"]*)" with "([^"]*)"$/ do |arg1, arg2|
+    @object.associate_with( @currency, @client)
+      
+end
+
+Given /^some NamedLevelCollection with some NamedLevel$/ do
+    @nlc = BigDoor::NamedLevelCollection.new({
+        'pub_title'            => 'Test Named Level Collection title',
+        'pub_description'      => 'test named Level collection description',
+        'end_user_title'       => 'test named Level collection end user title',
+        'end_user_description' => 'test named Level collection end user description',
+        'currency_id'          => @currency.resource_id,
+    })
+    @nlc.save( @client )
+
+    @nl = BigDoor::NamedLevel.new({
+        'pub_title'                 => 'Named Level pub title',
+        'pub_description'           => 'Named Level pub description',
+        'end_user_title'            => 'Named Level end user title',
+        'end_user_description'      => 'Named Level end user description',
+        'relative_weight'           => 1,
+        'threshold'                 => 10,
+        'named_level_collection_id' => @nlc.resource_id,
+    })
+    @nl.save( @client )
+end
+
+Given /^some NamedAwardCollection with some NamedAward$/ do
+    @nac = BigDoor::NamedAwardCollection.new({
+        'pub_title'            => 'Test Named Award Collection title',
+        'pub_description'      => 'test named Award collection description',
+        'end_user_title'       => 'test named Award collection end user title',
+        'end_user_description' => 'test named Award collection end user description',
+    })
+    @nac.save( @client )
+
+    @na = BigDoor::NamedAward.new({
+        'pub_title'                 => 'Named Award pub title',
+        'pub_description'           => 'Named Award pub description',
+        'end_user_title'            => 'Named Award end user title',
+        'end_user_description'      => 'Named Award end user description',
+        'relative_weight'           => 1,
+        'named_award_collection_id' => @nac.resource_id,
+    })
+    @na.save( @client )
+end
+
+Given /^some NamedGoodCollection with some NamedGood$/ do
+    @ngc = BigDoor::NamedGoodCollection.new({
+        'pub_title'            => 'Test Named Good Collection title',
+        'pub_description'      => 'test named Good collection description',
+        'end_user_title'       => 'test named Good collection end user title',
+        'end_user_description' => 'test named Good collection end user description',
+    })
+    @ngc.save( @client )
+
+    @ng = BigDoor::NamedGood.new({
+        'pub_title'                 => 'Named Good pub title',
+        'pub_description'           => 'Named Good pub description',
+        'end_user_title'            => 'Named Good end user title',
+        'end_user_description'      => 'Named Good end user description',
+        'relative_weight'           => 1,
+        'named_good_collection_id' => @ngc.resource_id,
+    })
+    @ng.save( @client )
+end
+
+Given /^some NamedTransactionGroup with some NamedTransaction$/ do
+    @ntg = BigDoor::NamedTransactionGroup.new({ 
+        'pub_title'             => 'Test Transaction Group',
+        'pub_description'       => 'test description',
+        'end_user_title'        => 'end user title',
+        'end_user_description'  => 'end user description',
+        'end_user_cap'          => '-1',
+        'end_user_cap_interval' => '-1',
+    })
+    @ntg.save( @client )
+
+    @nt = BigDoor::NamedTransaction.new({
+        'pub_title'            => 'Test Transaction',
+        'pub_description'      => 'test description',
+        'end_user_title'       => 'end user title',
+        'end_user_description' => 'end user description',
+        'currency_id'          => @currency.resource_id,
+        'amount'               => '50',
+        'default_amount'       => '50',
+    })
+    @nt.save( @client )
+
+    @ntg.associate_with( @nt, @client, 1 )
+end
+
+Given /^some NamedTransactionGroup with some NamedTransaction with Good$/ do
+    @ntg = BigDoor::NamedTransactionGroup.new({ 
+        'pub_title'             => 'Test Transaction Group',
+        'pub_description'       => 'test description',
+        'end_user_title'        => 'end user title',
+        'end_user_description'  => 'end user description',
+        'end_user_cap'          => '-1',
+        'end_user_cap_interval' => '-1',
+        'has_good'              => 'true',
+    })
+    @ntg.save( @client )
+
+    @ntwg = BigDoor::NamedTransaction.new({
+        'pub_title'            => 'Test Transaction',
+        'pub_description'      => 'test description',
+        'end_user_title'       => 'end user title',
+        'end_user_description' => 'end user description',
+        'named_good_id'           => @ng.resource_id,
+        'currency_id'          => @currency.resource_id,
+#        'amount'               => '150',
+#        'default_amount'       => '150',
+    })
+    @ntwg.save( @client )
+
+    @ntg.associate_with( @ntwg, @client, 1 )
+end
+
+Given /^freshly created "([^"]*)" object with "([^"]*)" name$/ do |arg1, arg2|
+    @username = (0...10).map{ ('a'..'z').to_a[rand(26)] }.join
+    @object = BigDoor::EndUser.new({
+        'end_user_login' => @username
+    }) 
+    @object.save( @client )
+end
+
+When /^I execute NamedTransactionGroup$/ do
+    @ntg.execute( @username, { 'good_receiver' => @username , 'verbosity' => '9', 'allow_negative_balance' => 'true'}, @client )
+end
+
+When /^I create and save a new "EndUser" object with "random" name$/ do
+    @username = (0...10).map{ ('a'..'z').to_a[rand(26)] }.join
+    @object = BigDoor::EndUser.new({
+        'end_user_login' => @username
+    }) 
+    @object.save( @client )
+end
+
+When /^I assign Award to EndUser$/ do
+    award = BigDoor::Award.new({ 
+        'end_user_login' => @username,
+        'named_award_id' => @na.resource_id
+    })
+    award.save( @client )
+end
+
+
+When /^save object$/ do
+      @object.save( @client )
+end
+
+When /^load object$/ do
+      @object.load( @client )
+end
+
+Then /^I should get list of "(\w+)" objects$/ do |class_name|
+    @list_all.should be_a_instance_of( Array )
+end
+
+Then /^I should get list of all "(\d+)" "(\w+)" objects$/ do |number, class_name|
+    @list_all.should be_a_instance_of( Array )
+    @list_all.should have(number.to_i).items
+    if number.to_i > 0
+        @list_all[0].should be_a_instance_of( eval(sprintf "BigDoor::%s", class_name) )
+        unless class_name == 'CurrencyBalance'
+            @list_all[0].load( @client )
+        end
+    end
+end
+
+Then /^I should get a "(\w+)" object$/ do |class_name|
+    @object.should be_a_instance_of( eval(sprintf "BigDoor::%s", class_name) )
+end
+
+Then /^object should has resource_id defined$/ do
+    @object.should respond_to(:resource_id)
+    @object.resource_id.should be
+    @object.resource_id.to_s.should match(/\d+/)
+end
+
+Then /^object should has guid defined$/ do
+    @object.should respond_to(:guid)
+    @object.guid.should be
+    @object.guid.to_s.should match(/[a-f\d]+/)
+end
+
+Then /^I should see Leaderboard$/ do
+    lb = BigDoor::Leaderboard.new()
+    lb.execute({ 
+        'format' => 'json', 
+        'verbosity' => '9', 
+        'type' => 'currency', 
+        'filter_value' => @currency.resource_id }, 
+        @client )
+
+end
+Then /^I should be able to remove object$/ do
+    @object.should respond_to(:delete)
+    @object.delete( @client )
+end
+
+Then /^collection should be removed too$/ do
+    @collection.should respond_to(:delete)
+    @collection.delete( @client )
+end
+
+Then /^Currency should be removed$/ do
+    @currency.delete( @client )
+end
+
+Then /^"([^"]*)" object should be removed$/ do |arg1|
+    @object.delete( @client )
+end
+
+Then /^"NamedAwardCollection" should be removed$/ do
+    @nac.delete( @client )
+end
+
+Then /^"NamedGoodCollection" should be removed$/ do
+    @ngc.delete( @client )
+end
+
+Then /^"NamedLevelCollection" should be removed$/ do
+    @nlc.delete( @client )
+end
+
+Then /^"NamedTransactionGroup" should be removed$/ do
+    @ntg.delete( @client )
+end
+
+Then /^I should be able to assign "Profile" to "EndUser"$/ do
+    @profile = BigDoor::Profile.new({
+        'provider'      => 'publisher',
+        'email'         => 'end_user@example.com',
+        'first_name'    => 'John',
+        'last_name'     => 'Doe',
+        'display_name'  => 'John Doe',
+        'profile_photo' => 'http://example.com/image.jpg',
+        'example_key'   => 'Example Value',
+        'end_user_login' => @username,
+    })
+    @profile.save( @client )
+end

data/features/support/env.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../../lib')
+
+require 'big_door'
+
+FAKE_APP_KEY    = '28d3da80bf36fad415ab57b3130c6cb6'
+FAKE_APP_SECRET = 'B66F956ED83AE218612CB0FBAC2EF01C'
+
+TEST_APP_KEY    = ENV['BIGDOOR_API_KEY']    || FAKE_APP_KEY
+TEST_APP_SECRET = ENV['BIGDOOR_API_SECRET'] || FAKE_APP_SECRET

data/lib/big_door/attribute.rb

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

data/lib/big_door/award.rb

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