amiando 0.2.1 → 0.3.0

data/README.md

@@ -34,8 +34,8 @@ first_name instead of firstName.
 The full amiando API isn't fully implemented yet, however you can find here the
 ones currently available.
 
-* [ApiKey](http://rdoc.info/github/xing/amiando/master/Amiando/ApiKeyt)
-* Partner
+* [ApiKey](http://rdoc.info/github/xing/amiando/master/Amiando/ApiKey)
+* [Partner](http://rdoc.info/github/xing/amiando/master/Amiando/Partner)
 * [User](http://rdoc.info/github/xing/amiando/master/Amiando/User) (some methods
   still missing)
 * [Event](http://rdoc.info/github/xing/amiando/master/Amiando/Event)

data/lib/amiando.rb

@@ -7,13 +7,15 @@ module Amiando
   autoload :Resource,       'amiando/resource'
   autoload :Boolean,        'amiando/boolean'
   autoload :Result,         'amiando/result'
+  autoload :Autorun,        'amiando/autorun'
+
   autoload :ApiKey,         'amiando/api_key'
   autoload :User,           'amiando/user'
+  autoload :Partner,        'amiando/partner'
   autoload :Event,          'amiando/event'
   autoload :TicketCategory, 'amiando/ticket_category'
   autoload :TicketShop,     'amiando/ticket_shop'
   autoload :PaymentType,    'amiando/payment_type'
-  autoload :Autorun,        'amiando/autorun'
 
   module Error
     class ServiceDown    < Exception; end

data/lib/amiando/api_key.rb

@@ -11,8 +11,8 @@ module Amiando
     def self.create(attributes)
       raise ArgumentError.new('ApiKey name field is mandatory') unless attributes[:name]
 
-      object  = new
-      request = post object, '/api/apiKey/create', :params => attributes
+      object = new
+      post object, '/api/apiKey/create', :params => attributes
 
       object
     end
@@ -22,8 +22,8 @@ module Amiando
     #
     # @param [Hash] possible attributes that can be updated.
     def self.update(id, attributes)
-      object  = Boolean.new(:success)
-      request = post object, "/api/apiKey/#{id}", :params => attributes
+      object = Boolean.new(:success)
+      post object, "/api/apiKey/#{id}", :params => attributes
 
       object
     end

data/lib/amiando/event.rb

@@ -23,8 +23,8 @@ module Amiando
     # @return [Event] will not return the full event and only the id attribute
     #   will be available.
     def self.create(attributes)
-      object  = new
-      request = post object, '/api/event/create',
+      object = new
+      post object, '/api/event/create',
         :params          => map_params(attributes),
         :populate_method => :populate_create
 
@@ -36,13 +36,8 @@ module Amiando
     #
     # @return [Boolean] if it was successful or not.
     def self.update(id, attributes)
-      object = Result.new do |response_body, result|
-        unless response_body['success']
-          result.errors = response_body['errors']
-        end
-        response_body['success']
-      end
-      request = post object, "/api/event/#{id}", :params => map_params(attributes)
+      object = Result.new
+      post object, "/api/event/#{id}", :params => map_params(attributes)
 
       object
     end
@@ -50,8 +45,8 @@ module Amiando
     ##
     # Fetch an event
     def self.find(id)
-      object  = new
-      request = get object, "/api/event/#{id}"
+      object = new
+      get object, "/api/event/#{id}"
 
       object
     end
@@ -59,9 +54,8 @@ module Amiando
     ##
     # See if an event id exists
     def self.exists?(identifier)
-      object  = Boolean.new('exists')
-      request = get object, "api/event/exists",
-        :params => { :identifier => identifier }
+      object = Boolean.new('exists')
+      get object, "api/event/exists", :params => { :identifier => identifier }
 
       object
     end
@@ -74,7 +68,7 @@ module Amiando
     # @return [Boolean] with the result of the operation
     def self.delete(id)
       object = Boolean.new('deleted')
-      request = do_request object, :delete, "/api/event/#{id}"
+      do_request object, :delete, "/api/event/#{id}"
 
       object
     end
@@ -86,13 +80,8 @@ module Amiando
     #
     # @return [Result] if it was activated or not.
     def self.activate(id)
-      object = Result.new do |response_body, result|
-        unless response_body['success']
-          result.errors = response_body['errors']
-        end
-        response_body['success']
-      end
-      request = post object, "/api/event/#{id}/activate"
+      object = Result.new
+      post object, "/api/event/#{id}/activate"
 
       object
     end
@@ -108,17 +97,21 @@ module Amiando
         raise ArgumentError.new('Events can be searched either by identifier or by title, include only one.')
       end
 
-      object  = Result.new { |response_body| response_body['ids'] }
-      request = get object, '/api/event/find', :params => by
+      object = Result.new { |response_body| response_body['ids'] }
+      get object, '/api/event/find', :params => by
 
       object
     end
 
+    ##
+    # @param user id
+    #
+    # @return [Result] with a list of the event ids by this user
     def self.find_all_by_user_id(user_id)
       object = Result.new do |response_body|
         response_body['events']
       end
-      request = get object, "/api/user/#{user_id}/events"
+      get object, "/api/user/#{user_id}/events"
       object
     end
 

data/lib/amiando/partner.rb

@@ -0,0 +1,61 @@
+module Amiando
+
+  ##
+  # http://developers.amiando.com/index.php/REST_API_Partner
+  class Partner < Resource
+    map :admin_id, :adminId
+    map :default_country, :defaultCountry
+    map :menu_css_url, :menuCssUrl
+    map :ticket_shop_css_url, :ticketShopCssUrl
+    map :sso_callback, :ssoCallback
+    map :referrer_partner_id, :referrerPartnerId
+
+    ##
+    # Creates a partner.
+    #
+    # @param [Hash] attributes
+    #
+    # @return [Partner] but will only have the id loaded
+    def self.create(attributes)
+      object = new
+      post object, '/api/partner/create',
+        :params          => map_params(attributes),
+        :populate_method => :populate_create
+
+      object
+    end
+
+    ##
+    # Updates the partner.
+    #
+    # @param the internal id of the partner to update.
+    # @param [Hash] attributes
+    #
+    # @return [Result] saying if the update was successful
+    def self.update(id, attributes)
+      object = Result.new
+      post object, "/api/partner/#{id}", :params => map_params(attributes)
+
+      object
+    end
+
+    ##
+    # @param id of the partner
+    #
+    # @return [Partner] the partner with that id
+    def self.find(id)
+      object = new
+      get object, "/api/partner/#{id}"
+
+      object
+    end
+
+    private
+
+    def populate(response_body)
+      extract_attributes_from(response_body, 'partner')
+    end
+  end
+end
+
+

data/lib/amiando/payment_type.rb

@@ -1,23 +1,21 @@
 module Amiando
   class PaymentType < Resource
 
-#     /event/{id}/paymentTypes <-- all paymentTypes of the event
-# /event/{id}/paymentType/create <-- creating a new paymentType
-# /paymentType/{id} <-- returns the paymentType (used for udpates etc)
-
-# PaymentType has just the following three variables:
-
-# Id
-# Type (String of the following: {PAYMENT_TYPE_ELV, PAYMENT_TYPE_CC, PAYMENT_TYPE_INVOICE, PAYMENT_TYPE_PREPAYMENT, PAYMENT_TYPE_PP, PAYMENT_TYPE_ONLOCATION}) [CC = CreditCard, PP = PayPal]
-# Active (boolean)
     ##
     # Create a payment type for an event
     #
     # @param event id
-    # @param [Type] Type (String of the following:
-    #   PAYMENT_TYPE_ELV, PAYMENT_TYPE_CC, PAYMENT_TYPE_INVOICE, PAYMENT_TYPE_PREPAYMENT,
-    #   PAYMENT_TYPE_PP, PAYMENT_TYPE_ONLOCATION) [CC = CreditCard, PP = PayPal]
-    #   It will also accept :cc, :invoice, etc and convert them appropiately
+    # @param string or symbol of the following:
+    #   * PAYMENT_TYPE_ELV
+    #   * PAYMENT_TYPE_CC
+    #   * PAYMENT_TYPE_INVOICE
+    #   * PAYMENT_TYPE_PREPAYMENT
+    #   * PAYMENT_TYPE_PP
+    #   * PAYMENT_TYPE_ONLOCATION
+    #
+    #   [CC = CreditCard, PP = PayPal]
+    #
+    #   It will also accept :cc, :invoice, etc and convert them appropriately
     #
     def self.create(event_id, type)
       unless type =~ /payment_type_\w+/i
@@ -25,12 +23,8 @@ module Amiando
       end
 
       object = Result.new do |response_body, result|
-        if response_body['success']
-          response_body['id']
-        else
-          result.errors = response_body['errors']
-          false
-        end
+        result.errors = response_body['errors']
+        response_body['id'] || false
       end
 
       post object, "api/event/#{event_id}/paymentType/create", :params => { :type => type.upcase }
@@ -38,6 +32,10 @@ module Amiando
       object
     end
 
+    ##
+    # @param event id
+    #
+    # @return [Result] with the list of payment types for that event.
     def self.find_all_by_event_id(event_id)
       object = Result.new do |response_body, result|
         if response_body['success']
@@ -55,6 +53,10 @@ module Amiando
       object
     end
 
+    ##
+    # @param payment type id
+    #
+    # @return [PaymentType] the payment type with that id
     def self.find(payment_type_id)
       object = new
 

data/lib/amiando/result.rb

@@ -10,12 +10,16 @@ module Amiando
   class Result
     include Amiando::Autorun
 
-    attr_accessor :request, :response, :errors
+    attr_accessor :request, :response, :errors, :success
 
-    autorun :request, :response, :result, :errors
+    autorun :request, :response, :result, :errors, :success
 
     def initialize(&block)
       @populator = block
+      @populator ||= Proc.new do |response_body, result|
+        result.errors = response_body['errors']
+        response_body['success']
+      end
     end
 
     def populate(response_body)
@@ -24,6 +28,7 @@ module Amiando
       elsif @populator.arity == 2
         @result = @populator.call(response_body, self)
       end
+      @success = response_body['success']
     end
   end
 end

data/lib/amiando/ticket_category.rb

@@ -35,15 +35,7 @@ module Amiando
     #
     # @param [Hash] attributes
     def self.update(ticket_category_id, attributes)
-      object = Result.new do |response_body, result|
-        if response_body['success']
-          true
-        else
-          result.errors = response_body['errors']
-          false
-        end
-      end
-
+      object = Result.new
       post object, "api/ticketCategory/#{ticket_category_id}", :params => attributes
 
       object

data/lib/amiando/ticket_shop.rb

@@ -34,8 +34,8 @@ module Amiando
     #
     # @return [TicektShop] the event's ticketshop
     def self.find(event_id)
-      object  = new
-      request = get object, "api/event/#{event_id}/ticketShop"
+      object = new
+      get object, "api/event/#{event_id}/ticketShop"
 
       object
     end
@@ -47,8 +47,8 @@ module Amiando
     #
     # @return [Boolean] deferred object indicating the result of the update.
     def self.update(event_id, attributes)
-      object  = Boolean.new('success')
-      request = post object, "/api/event/#{event_id}/ticketShop", :params => map_params(attributes)
+      object = Boolean.new('success')
+      post object, "/api/event/#{event_id}/ticketShop", :params => map_params(attributes)
 
       object
     end

data/lib/amiando/user.rb

@@ -12,7 +12,7 @@ module Amiando
     # @param [String] username
     def self.exists?(username)
       object  = Boolean.new('exists')
-      request = get object, "api/user/exists",
+      get object, "api/user/exists",
         :params => { :username => username }
 
       object
@@ -28,7 +28,7 @@ module Amiando
         response_body['ids'].first
       end
 
-      request = get object, "api/user/find",
+      get object, "api/user/find",
         :params => { :username => username }
 
       object
@@ -41,7 +41,7 @@ module Amiando
     # @param [Hash] attributes
     def self.create(attributes)
       object  = new
-      request = post object, '/api/user/create',
+      post object, '/api/user/create',
         :params          => map_params(attributes),
         :populate_method => :populate_create
 
@@ -56,7 +56,7 @@ module Amiando
     # @param [String] username
     def self.update(user_id, attributes)
       object  = Boolean.new('success')
-      request = post object, "/api/user/#{user_id}", :params => map_params(attributes)
+      post object, "/api/user/#{user_id}", :params => map_params(attributes)
 
       object
     end
@@ -68,7 +68,7 @@ module Amiando
     # @param user_id
     def self.find(user_id)
       object = new
-      request = get object, "api/user/#{user_id}"
+      get object, "api/user/#{user_id}"
 
       object
     end
@@ -80,7 +80,7 @@ module Amiando
     # @param user_id
     def self.delete(user_id)
       object = Boolean.new('deleted')
-      request = do_request object, :delete, "/api/user/#{user_id}"
+      do_request object, :delete, "/api/user/#{user_id}"
 
       object
     end
@@ -90,16 +90,8 @@ module Amiando
     # @param user_id
     # @param [String] password
     def self.request_permission(user_id, password)
-      object = Result.new do |response_body, result|
-        if response_body['success']
-          true
-        else
-          result.errors = response_body['errors']
-          false
-        end
-      end
-
-      request = post object, "api/user/#{user_id}/requestPermission", :params => { :password => password }
+      object  = Result.new
+      post object, "api/user/#{user_id}/requestPermission", :params => { :password => password }
 
       object
     end
@@ -111,7 +103,7 @@ module Amiando
     # @param user_id
     def self.logout(user_id)
       object = Boolean.new('success')
-      request = post object, "/api/user/#{user_id}/logout"
+      post object, "/api/user/#{user_id}/logout"
 
       object
     end

data/lib/amiando/version.rb

@@ -1,3 +1,3 @@
 module Amiando
-  VERSION = "0.2.1"
+  VERSION = "0.3.0"
 end

data/test/amiando/partner_test.rb

@@ -0,0 +1,88 @@
+require 'test_helper'
+
+describe Amiando::Partner do
+  before do
+    HydraCache.prefix = 'Partner'
+  end
+
+  after do
+    HydraCache.prefix = nil
+  end
+
+  describe 'create' do
+    it 'creates a partner successfully' do
+      api_key = Amiando::Factory.create(:api_key, :name => "partner-create-#{HydraCache.revision}")
+      Amiando.with_key api_key.key do
+        username = "partner_create-#{HydraCache.revision}@example.com"
+        user     = Amiando::Factory.create(:user, :username => username)
+        partner  = Amiando::Partner.create(
+          :admin_id        => user.id,
+          :name            => "Partner name",
+          :language        => "en",
+          :default_country => "ES"
+        )
+        Amiando.run
+
+        partner.id.wont_be_nil
+      end
+    end
+
+    it 'handles errors' do
+      partner = Amiando::Partner.create(
+        :admin_id        => nil,
+        :name            => "Partner name",
+        :language        => "en",
+        :default_country => "ES"
+      )
+      Amiando.run
+
+      partner.errors.wont_be_empty
+    end
+  end
+
+  describe 'update' do
+    it 'updates the object' do
+      api_key = Amiando::Factory.create(:api_key, :name => "partner-update-#{HydraCache.revision}")
+      Amiando.with_key api_key.key do
+        username = "partner_update-#{HydraCache.revision}@example.com"
+        user     = Amiando::Factory.create(:user, :username => username)
+        partner  = Amiando::Partner.create(
+          :admin_id        => user.id,
+          :name            => "Partner name",
+          :language        => "en",
+          :default_country => "ES"
+        )
+        Amiando.run
+
+        update = Amiando::Partner.update(partner.id, :name => 'wadus')
+        Amiando.run
+
+        update.result.must_equal true
+      end
+    end
+  end
+
+  describe 'find' do
+    it 'finds the object' do
+      api_key = Amiando::Factory.create(:api_key, :name => "partner-find-#{HydraCache.revision}")
+      Amiando.with_key api_key.key do
+        username = "partner_find-#{HydraCache.revision}@example.com"
+        user     = Amiando::Factory.create(:user, :username => username)
+        partner  = Amiando::Partner.create(
+          :admin_id        => user.id,
+          :name            => "to be found",
+          :language        => "en",
+          :default_country => "ES"
+        )
+        Amiando.run
+
+        found = Amiando::Partner.find(partner.id)
+        Amiando.run
+
+        found.must_equal partner
+        found.name.must_equal "to be found"
+      end
+    end
+  end
+
+end