amiando 0.0.1

data/lib/amiando/result.rb

@@ -0,0 +1,33 @@
+module Amiando
+
+  ##
+  # This object is intended to be used when an api will return value that is
+  # not a resource object (a User, an Event, etc), but due to the delayed
+  # nature of doing requests in parallel, can't be initialized from the beginning.
+  #
+  # After the object is populated, you can ask the result with the result
+  # method.
+  class Result
+    attr_accessor :request, :response, :errors
+
+    def initialize(&block)
+      @populator = block
+    end
+
+    def populate(response_body)
+      if @populator.arity == 1
+        @result = @populator.call(response_body)
+      elsif @populator.arity == 2
+        @result = @populator.call(response_body, self)
+      end
+    end
+
+    def result
+      if defined?(@result)
+        @result
+      else
+        raise Error::NotInitialized.new('Called result before the query was run')
+      end
+    end
+  end
+end

data/lib/amiando/ticket_category.rb

@@ -0,0 +1,99 @@
+module Amiando
+
+  ##
+  # http://developers.amiando.com/index.php/REST_API_TicketCategories
+  class TicketCategory < Resource
+    map :sale_start,         :saleStart, :type => :time
+    map :sale_end,           :saleEnd,   :type => :time
+    map :reserved_count,     :reservedCount
+    map :min_sell,           :minSell
+    map :max_sell,           :maxSell
+    map :default_value,      :defaultValue
+    map :min_sell_required,  :minSellRequired
+    map :ticket_description, :ticketDescription
+    map :display_price,      :displayPrice
+    map :display_quantity,   :displayQuantity
+    map :price_editable,     :priceEditable
+
+    ##
+    # Creates a ticket category for an event
+    # The returned object only contains the id or errors.
+    #
+    # @param event_id
+    # @param [Hash] attributes
+    def self.create(event_id, attributes)
+      object = new
+      post object, "api/event/#{event_id}/ticketCategory/create",
+        :params => attributes,
+        :populate_method => :populate_create
+
+      object
+    end
+
+    ##
+    # Update  a ticket_category
+    #
+    # @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
+
+      post object, "api/ticketCategory/#{ticket_category_id}", :params => attributes
+
+      object
+    end
+
+    ##
+    # Find a ticket category.
+    #
+    # @param ticket category id
+    #
+    # @return [TicketCategory]
+    def self.find(ticket_category_id)
+      object = new
+      get object, "api/ticketCategory/#{ticket_category_id}"
+
+      object
+    end
+
+    ##
+    # @param event id
+    # @param [Symbol]
+    #   :ids if you only want to fetch the ids.
+    #   :full if you want the whole objects
+    #
+    # @return [Result] with all the ticket category ids for this event.
+    def self.find_all_by_event_id(event_id, type = :ids)
+      object = Result.new do |response_body, result|
+        if response_body['success']
+          if type == :ids
+            response_body['ticketCategories']
+          else
+            response_body['ticketCategories'].map do |category|
+              new(category)
+            end
+          end
+        else
+          result.errors = response_body['errors']
+          false
+        end
+      end
+
+      get object, "/api/event/#{event_id}/ticketCategories", :params => {:resultType => type}
+
+      object
+    end
+
+    private
+
+    def populate(response_body)
+      extract_attributes_from(response_body, 'ticketCategory')
+    end
+  end
+end

data/lib/amiando/ticket_shop.rb

@@ -0,0 +1,63 @@
+module Amiando
+
+  ##
+  # From the documentation:
+  #
+  # http://developers.amiando.com/index.php/REST_API_TicketShops
+  #
+  #   A ticketshop will automatically be created when you create an event.
+  #   That's why you only have read and update access, but no create access.
+  #   If you delete the related event, the ticketshop will also be deleted.
+  #
+  class TicketShop < Resource
+
+    map :ticket_base_fee, :ticketBaseFee
+    map :product_disagio, :productDisagio
+    map :fee_inclusive, :feeInclusive
+    map :shipment_fee_inclusive, :shipmentFeeInclusive
+    map :sales_tax, :salesTax
+    map :available_limit, :availableLimit
+    map :show_available_tickets, :showAvailableTickets
+    map :cancelation_possible, :cancelationPossible
+    map :num_tickets_sold, :numTicketsSold
+    map :total_income, :totalIncome
+    map :total_fees, :totalFees
+    map :collect_user_data, :collectUserData
+    map :max_possible_number_of_participants, :maxPossibleNumberOfParticipants
+    map :num_tickets_checked, :numTicketsChecked
+
+
+    ##
+    # Get the ticket shop of an event.
+    #
+    # @param event id
+    #
+    # @return [TicektShop] the event's ticketshop
+    def self.find(event_id)
+      object  = new
+      request = get object, "api/event/#{event_id}/ticketShop"
+
+      object
+    end
+
+    ##
+    # Updates the ticket shop.
+    #
+    # @param [String] username
+    #
+    # @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
+    end
+
+
+    private
+
+    def populate(response_body)
+      extract_attributes_from(response_body, 'ticketShop')
+    end
+  end
+end

data/lib/amiando/user.rb

@@ -0,0 +1,148 @@
+module Amiando
+
+  ##
+  # http://developers.amiando.com/index.php/REST_API_Users
+  class User < Resource
+    map :first_name, :firstName
+    map :last_name,  :lastName
+
+    ##
+    # Will return a {Boolean} deferred object containing the result
+    #
+    # @param [String] username
+    def self.exists?(username)
+      object  = Boolean.new('exists')
+      request = get object, "api/user/exists",
+        :params => { :username => username }
+
+      object
+    end
+
+    ##
+    # Find a user given the username (email)
+    #
+    # @param [String] username
+    # @return [Result] with the user's id
+    def self.find_by_username(username)
+      object = Result.new do |response_body|
+        response_body['ids'].first
+      end
+
+      request = get object, "api/user/find",
+        :params => { :username => username }
+
+      object
+    end
+
+    ##
+    # Creates a user. It will not return the full user and only the id
+    # attribute will be available.
+    #
+    # @param [Hash] attributes
+    def self.create(attributes)
+      object  = new
+      request = post object, '/api/user/create',
+        :params          => map_params(attributes),
+        :populate_method => :populate_create
+
+      object
+    end
+
+    ##
+    # Updates a user.
+    # Will return a {Boolean} deferred object indicating
+    # the result of the update
+    #
+    # @param [String] username
+    def self.update(user_id, attributes)
+      object  = Boolean.new('success')
+      request = post object, "/api/user/#{user_id}", :params => map_params(attributes)
+
+      object
+    end
+
+    ##
+    # Find a user.
+    # Will return a user
+    #
+    # @param user_id
+    def self.find(user_id)
+      object = new
+      request = get object, "api/user/#{user_id}"
+
+      object
+    end
+
+    ##
+    # Deletes a user
+    # Returns a {Boolean} with the result of the operation
+    #
+    # @param user_id
+    def self.delete(user_id)
+      object = Boolean.new('deleted')
+      request = do_request object, :delete, "/api/user/#{user_id}"
+
+      object
+    end
+
+    ## Request permission to use and api key on behalf of a user
+    #
+    # @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
+    end
+
+    ##
+    # Tries to log out the user_id. Will raise Error::NotAuthorized if
+    # trying to logout a user you don't have permission for.
+    #
+    # @param user_id
+    def self.logout(user_id)
+      object = Boolean.new('success')
+      request = post object, "/api/user/#{user_id}/logout"
+
+      object
+    end
+
+    def ==(user)
+      id == user.id
+    end
+
+    private
+
+    def populate(response_body)
+      extract_attributes_from(response_body, 'user')
+    end
+
+    # def bank_account(id)
+    #   request :get, "api/user/#{id}/bankAccount"
+    # end
+
+    # def address_billing(id)
+    #   request :get, "api/user/#{id}/address/billing"
+    # end
+
+    ##
+    # Tries to get permission to work on user_id.
+    # def request_permission(user_id, password)
+    #   post "api/user/#{user_id}/requestPermission", :password => password
+    # end
+
+    # def events(user_id)
+    #   get "api/user/#{user_id}/events"
+    # end
+  end
+
+end

data/lib/amiando/version.rb

@@ -0,0 +1,3 @@
+module Amiando
+  VERSION = "0.0.1"
+end

data/test/amiando/amiando_test.rb

@@ -0,0 +1,13 @@
+require 'test_helper'
+
+describe Amiando do
+  it 'should return the right url for the test environment' do
+    Amiando.base_url.must_equal 'https://test.amiando.com'
+  end
+
+  it 'should return the right url for the production environment' do
+    Amiando.production!
+    Amiando.base_url.must_equal 'https://amiando.com'
+    Amiando.development!
+  end
+end

data/test/amiando/api_key_test.rb

@@ -0,0 +1,58 @@
+require 'test_helper'
+
+describe Amiando::ApiKey do
+  before do
+    Amiando.api_key   = nil
+    HydraCache.prefix = 'ApiKey'
+  end
+
+  after do
+    Amiando.api_key   = nil
+    HydraCache.prefix = nil
+  end
+
+  describe 'create' do
+    it 'creates an api key' do
+      key = Amiando::ApiKey.create :name => 'wadus'
+      Amiando.run
+
+      key.id.wont_be_nil
+      key.name.must_equal 'wadus'
+      key.identifier.wont_be_nil
+      key.key.wont_be_nil
+      key.enabled.wont_be_nil
+    end
+
+    it 'fails when creating with empty parameters' do
+      lambda { key = Amiando::ApiKey.create({}) }.must_raise ArgumentError
+    end
+
+  end
+
+  describe 'update' do
+    it 'can update its enabled attribute' do
+      key = Amiando::ApiKey.create :name => 'wadus'
+      Amiando.run
+
+      Amiando.api_key = key.key
+
+      update = Amiando::ApiKey.update(key.id, :enabled => false)
+      Amiando.run
+
+      update.result.must_equal true
+    end
+
+    it 'update raises NotAuthorized if apikey doesnt have permission to update the apikey' do
+      key1 = Amiando::ApiKey.create :name => 'wadus'
+      key2 = Amiando::ApiKey.create :name => 'wadus1'
+      Amiando.run
+
+      Amiando.api_key = key1.key
+
+      lambda {
+        result = Amiando::ApiKey.update(key2.id, :enabled => false)
+        Amiando.run
+      }.must_raise Amiando::Error::NotAuthorized
+    end
+  end
+end

data/test/amiando/boolean_test.rb

@@ -0,0 +1,21 @@
+require 'test_helper'
+
+describe Amiando::Boolean do
+  it "raises error if you try to get the result before it's been calculated" do
+    lambda { Amiando::Boolean.new(:wadus).result }.must_raise Amiando::Error::NotInitialized
+  end
+
+  it "raises error if you try to get the result before it's been calculated" do
+    lambda {
+      boolean = Amiando::Boolean.new(:wadus)
+      boolean.populate('not_wadus' => true)
+    }.must_raise Amiando::Error::NotInitialized
+  end
+
+  it "uses the passed attribute to know its result on populate" do
+    boolean = Amiando::Boolean.new(:wadus)
+    boolean.populate('wadus' => false)
+
+    boolean.result.must_equal false
+  end
+end