amiando 0.3.0 → 0.3.1

data/.gitignore

@@ -4,3 +4,4 @@ Gemfile.lock
 pkg/*
 /.rvmrc
 /TAGS
+/.yardoc/*

data/README.md

@@ -5,6 +5,17 @@ documentation here:
 
 http://developers.amiando.com/index.php/REST_API
 
+## Installation
+
+Simply install with:
+
+    gem install amiando
+
+To parse the json results we use the [multi_json](https://rubygems.org/gems/multi_json)
+gem. We suggest that you add at least one fast json parsing library, like
+[json](https://rubygems.org/gems/json) or [yajl-ruby](https://rubygems.org/gems/yajl-ruby).
+Otherwise it will use `multi_json`'s bundled json parser.
+
 ## Basic usage
 
 The gem has been implemented with the idea that requests can be done in
@@ -23,7 +34,7 @@ You can also do synchronous requests by prepending 'sync_' to the method name:
 
     albert = Amiando::User.sync_find(1234)
 
-### Note
+### Notation
 
 All attributes should be used in snake_case format instead of the CamelCase
 used in the official documentation. For example, for a user, you should call

data/amiando.gemspec

@@ -19,7 +19,7 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   s.add_dependency 'typhoeus'
-  s.add_dependency 'json'
+  s.add_dependency 'multi_json'
 
   s.add_development_dependency 'minitest'
   s.add_development_dependency 'webmock'

data/lib/amiando.rb

@@ -1,6 +1,6 @@
 require "amiando/version"
 require "typhoeus"
-require "json"
+require "multi_json"
 
 module Amiando
   autoload :Request,        'amiando/request'
@@ -36,14 +36,17 @@ module Amiando
     URL       = 'https://amiando.com'
     TEST_URL  = 'https://test.amiando.com'
 
+    # Connect to the production server
     def production!
       @production = true
     end
 
+    # Connect to the test server (default)
     def development!
       @production = false
     end
 
+    # @return [String] the url for the environment
     def base_url
       @production ? URL : TEST_URL
     end
@@ -52,6 +55,7 @@ module Amiando
       @requests ||= []
     end
 
+    # Runs all queued requests
     def run
       requests.each{ |request| hydra.queue(request) }
       hydra.run
@@ -63,6 +67,12 @@ module Amiando
       @hydra ||= Typhoeus::Hydra.new
     end
 
+    ##
+    # Allows to switch temporarily the API key
+    #
+    # @param [String] api API key
+    # @param [Block] block block to execute with the given key
+    # @return  the result of the block
     def with_key(key)
       old_key = Amiando.api_key
       Amiando.api_key = key
@@ -70,5 +80,6 @@ module Amiando
     ensure
       Amiando.api_key = old_key
     end
+
   end
 end

data/lib/amiando/api_key.rb

@@ -7,7 +7,10 @@ module Amiando
     ##
     # Creates an {ApiKey}.
     #
-    # @param [Hash] possible attributes that can be set on creation.
+    # @param [Hash] attributes possible attributes that can be set on creation.
+    #
+    # @raise [ArgumentError] if no name provided in attributes
+    # @return [ApiKey]
     def self.create(attributes)
       raise ArgumentError.new('ApiKey name field is mandatory') unless attributes[:name]
 
@@ -20,7 +23,8 @@ module Amiando
     ##
     # Updates an {ApiKey}.
     #
-    # @param [Hash] possible attributes that can be updated.
+    # @param [Hash] attributes possible attributes that can be updated.
+    # @return [Boolean]  the result value
     def self.update(id, attributes)
       object = Boolean.new(:success)
       post object, "/api/apiKey/#{id}", :params => attributes
@@ -28,6 +32,8 @@ module Amiando
       object
     end
 
+    protected
+
     def populate(response_body)
       extract_attributes_from(response_body, 'apiKey')
     end

data/lib/amiando/event.rb

@@ -20,6 +20,8 @@ module Amiando
     ##
     # Creates an event.
     #
+    # @param [Hash] attributes
+    #
     # @return [Event] will not return the full event and only the id attribute
     #   will be available.
     def self.create(attributes)
@@ -34,6 +36,9 @@ module Amiando
     ##
     # Updates an event.
     #
+    # @param id
+    # @param [Hash] attributes
+    #
     # @return [Boolean] if it was successful or not.
     def self.update(id, attributes)
       object = Result.new
@@ -44,6 +49,10 @@ module Amiando
 
     ##
     # Fetch an event
+    #
+    # @param id
+    #
+    # @return [Event]
     def self.find(id)
       object = new
       get object, "/api/event/#{id}"
@@ -53,6 +62,10 @@ module Amiando
 
     ##
     # See if an event id exists
+    #
+    # @param identifier
+    #
+    # @return [Boolean] if it exists or not
     def self.exists?(identifier)
       object = Boolean.new('exists')
       get object, "api/event/exists", :params => { :identifier => identifier }
@@ -63,7 +76,7 @@ module Amiando
     ##
     # Deletes an event
     #
-    # @param [Integer] event id
+    # @param [Integer] id event id
     #
     # @return [Boolean] with the result of the operation
     def self.delete(id)
@@ -76,7 +89,7 @@ module Amiando
     ##
     # Activate an event
     #
-    # @param [Integer] the event id
+    # @param [Integer] id event id
     #
     # @return [Result] if it was activated or not.
     def self.activate(id)
@@ -91,6 +104,7 @@ module Amiando
     #
     # @param [Hash] a hash with 1 entry, either :identifier or :title
     #
+    # @raise [ArgumentError] if no identifier or title supplied, or if both present
     # @return [Result] with an array of ids
     def self.search(by)
       unless by[:identifier].nil? ^ by[:title].nil? # XOR
@@ -104,7 +118,9 @@ module Amiando
     end
 
     ##
-    # @param user id
+    # Find all events from a user
+    #
+    # @param user_id
     #
     # @return [Result] with a list of the event ids by this user
     def self.find_all_by_user_id(user_id)
@@ -115,7 +131,7 @@ module Amiando
       object
     end
 
-    private
+    protected
 
     def populate(response_body)
       extract_attributes_from(response_body, 'event')

data/lib/amiando/partner.rb

@@ -28,7 +28,7 @@ module Amiando
     ##
     # Updates the partner.
     #
-    # @param the internal id of the partner to update.
+    # @param id the internal id of the partner to update.
     # @param [Hash] attributes
     #
     # @return [Result] saying if the update was successful
@@ -40,7 +40,9 @@ module Amiando
     end
 
     ##
-    # @param id of the partner
+    # Find a partner
+    #
+    # @param id id of the partner
     #
     # @return [Partner] the partner with that id
     def self.find(id)
@@ -57,5 +59,3 @@ module Amiando
     end
   end
 end
-
-

data/lib/amiando/payment_type.rb

@@ -4,8 +4,8 @@ module Amiando
     ##
     # Create a payment type for an event
     #
-    # @param event id
-    # @param string or symbol of the following:
+    # @param event_id
+    # @param type string or symbol of the following:
     #   * PAYMENT_TYPE_ELV
     #   * PAYMENT_TYPE_CC
     #   * PAYMENT_TYPE_INVOICE
@@ -33,7 +33,9 @@ module Amiando
     end
 
     ##
-    # @param event id
+    # Find all Payment Types of an event
+    #
+    # @param event_id
     #
     # @return [Result] with the list of payment types for that event.
     def self.find_all_by_event_id(event_id)
@@ -54,7 +56,9 @@ module Amiando
     end
 
     ##
-    # @param payment type id
+    # Find a Payment Type
+    #
+    # @param payment_type_id
     #
     # @return [PaymentType] the payment type with that id
     def self.find(payment_type_id)

data/lib/amiando/resource.rb

@@ -73,7 +73,7 @@ module Amiando
             raise Error::ServiceDown.new(response.body)
           end
 
-          parsed_body = JSON.parse(response.body)
+          parsed_body = MultiJson.decode(response.body)
 
           if parsed_body['errors'] && parsed_body['errors'].include?('com.amiando.api.rest.MissingParam.apikey')
             raise Error::MissingApiKey.new('This call requires an apikey')

data/lib/amiando/ticket_category.rb

@@ -21,6 +21,8 @@ module Amiando
     #
     # @param event_id
     # @param [Hash] attributes
+    #
+    # @return [TicketCategory] only id or errors are set
     def self.create(event_id, attributes)
       object = new
       post object, "api/event/#{event_id}/ticketCategory/create",
@@ -33,7 +35,10 @@ module Amiando
     ##
     # Update  a ticket_category
     #
+    # @param ticket_category_id
     # @param [Hash] attributes
+    #
+    # @return [Result] if it was succesful or not with possible errors
     def self.update(ticket_category_id, attributes)
       object = Result.new
       post object, "api/ticketCategory/#{ticket_category_id}", :params => attributes
@@ -44,7 +49,7 @@ module Amiando
     ##
     # Find a ticket category.
     #
-    # @param ticket category id
+    # @param ticket_category_id
     #
     # @return [TicketCategory]
     def self.find(ticket_category_id)
@@ -55,7 +60,7 @@ module Amiando
     end
 
     ##
-    # @param event id
+    # @param event_id
     # @param [Symbol]
     #   :ids if you only want to fetch the ids.
     #   :full if you want the whole objects
@@ -82,7 +87,7 @@ module Amiando
       object
     end
 
-    private
+    protected
 
     def populate(response_body)
       extract_attributes_from(response_body, 'ticketCategory')

data/lib/amiando/ticket_shop.rb

@@ -43,7 +43,8 @@ module Amiando
     ##
     # Updates the ticket shop.
     #
-    # @param [String] username
+    # @param event_id
+    # @param [Hash] attributes
     #
     # @return [Boolean] deferred object indicating the result of the update.
     def self.update(event_id, attributes)
@@ -53,8 +54,7 @@ module Amiando
       object
     end
 
-
-    private
+    protected
 
     def populate(response_body)
       extract_attributes_from(response_body, 'ticketShop')

data/lib/amiando/version.rb

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

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: amiando
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 17
   prerelease: 
   segments: 
   - 0
   - 3
-  - 0
-  version: 0.3.0
+  - 1
+  version: 0.3.1
 platform: ruby
 authors: 
 - Jorge Dias
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-10-26 00:00:00 +02:00
+date: 2011-10-28 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -34,7 +34,7 @@ dependencies:
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: json
+  name: multi_json
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false