maestrano 0.3.0 → 0.4.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    maestrano (0.2.0)
+    maestrano (0.3.0)
       json (~> 1.8)
       mime-types (~> 1.25)
       nokogiri (>= 1.5.0)

data/README.md

@@ -3,6 +3,24 @@
 </p>
 
 Maestrano Cloud Integration is currently in closed beta. Want to know more? Send us an email to <contact@maestrano.com>.
+  
+  
+  
+- - -
+
+1.  [Getting Setup](#getting-setup)
+2.  [Getting Started with Rails](#getting-started-with-rails)
+3.  [Getting Started](#getting-started)
+4. [Single Sign-On Setup](#single-sign-on-setup)
+  * [User Setup](#user-setup)
+  * [Group Setup](#group-setup)
+  * [Controller Setup](#controller-setup)
+  * [Other Controllers](#other-controllers)
+5. [API](#api)
+  * [Bill](#bill)
+  * [Recurring Bill](#recurring-bill)
+
+- - -
 
 ## Getting Setup
 Before integrating with us you will need an API Key. Maestrano Cloud Integration being still in closed beta you will need to contact us beforehand to gain production access.
@@ -18,7 +36,18 @@ If you're looking at integrating Maestrano in your Rails application then you sh
 More details on the [maestrano-rails project page](https://github.com/maestrano/maestrano-rails).
 
 ## Getting Started
-The first step is to create an initializer to configure the behaviour of the Maestrano gem - including setting your API key.
+
+To install the gem run
+```console
+gem install maestrano
+```
+
+Or add it to your Gemfile
+```ruby
+gem 'maestrano'
+```
+
+Once installed the first step is to create an initializer to configure the behaviour of the Maestrano gem - including setting your API key.
 
 The initializer should look like this:
 ```ruby
@@ -35,11 +64,12 @@ Maestrano.configure do |config|
   # More details on http://api-sandbox.maestrano.io
   config.environment = 'test' # or 'production'
   
-  # ==> API key
-  # Your application API key which you can retrieve on http://maestrano.com
+  # ==> App ID & API key
+  # Your application App ID and API key which you can retrieve on http://maestrano.com
   # via your cloud partner dashboard.
   # For testing you can retrieve/generate an api_key from the API Sandbox directly 
   # on http://api-sandbox.maestrano.io
+  config.app_id = (config.environment == 'production' ? 'prod_app_id' : 'sandbox_app_id')
   config.api_key = (config.environment == 'production' ? 'prod_api_key' : 'sandbox_api_key')
   
   # ==> Single Sign-On activation
@@ -244,3 +274,303 @@ def verify_maestrano_session
   true
 end
 ```
+
+## API
+The maestrano gem also provides bindings to its REST API allowing to access, create, update or delete various entities under your account (e.g: billing).
+
+### Payment API
+ 
+#### Bill
+A bill represents a single charge on a given group.
+
+```ruby
+Maestrano::Account::Bill
+```
+
+##### Attributes
+
+<table>
+<tr>
+<th>Field</th>
+<th>Mode</th>
+<th>Type</th>
+<th>Required</th>
+<th>Default</th>
+<th>Description</th>
+<tr>
+
+<tr>
+<td><b>id</b></td>
+<td>readonly</td>
+<td>string</td>
+<td>-</td>
+<td>-</td>
+<td>The id of the bill</td>
+<tr>
+
+<tr>
+<td><b>group_id</b></td>
+<td>read/write</td>
+<td>string</td>
+<td><b>Yes</b></td>
+<td>-</td>
+<td>The id of the group you are charging</td>
+<tr>
+
+<tr>
+<td><b>price_cents</b></td>
+<td>read/write</td>
+<td>Integer</td>
+<td><b>Yes</b></td>
+<td>-</td>
+<td>The amount in cents to charge to the customer</td>
+<tr>
+
+<tr>
+<td><b>description</b></td>
+<td>read/write</td>
+<td>String</td>
+<td><b>Yes</b></td>
+<td>-</td>
+<td>A description of the product billed as it should appear on customer invoice</td>
+<tr>
+
+<tr>
+<td><b>created_at</b></td>
+<td>readonly</td>
+<td>Time</td>
+<td>-</td>
+<td>-</td>
+<td>When the the bill was created</td>
+<tr>
+
+<tr>
+<td><b>status</b></td>
+<td>readonly</td>
+<td>String</td>
+<td>-</td>
+<td>-</td>
+<td>Status of the bill. Either 'submitted', 'invoiced' or 'cancelled'.</td>
+<tr>
+
+<tr>
+<td><b>currency</b></td>
+<td>read/write</td>
+<td>String</td>
+<td>-</td>
+<td>AUD</td>
+<td>The currency of the amount charged in <a href="http://en.wikipedia.org/wiki/ISO_4217#Active_codes">ISO 4217 format</a> (3 letter code)</td>
+<tr>
+
+<tr>
+<td><b>units</b></td>
+<td>read/write</td>
+<td>Decimal(10,2)</td>
+<td>-</td>
+<td>1.0</td>
+<td>How many units are billed for the amount charged</td>
+<tr>
+
+<tr>
+<td><b>period_started_at</b></td>
+<td>read/write</td>
+<td>Time</td>
+<td>-</td>
+<td>-</td>
+<td>If the bill relates to a specific period then specifies when the period started. Both period_started_at and period_ended_at need to be filled in order to appear on customer invoice.</td>
+<tr>
+
+<tr>
+<td><b>period_ended_at</b></td>
+<td>read/write</td>
+<td>Time</td>
+<td>-</td>
+<td>-</td>
+<td>If the bill relates to a specific period then specifies when the period ended. Both period_started_at and period_ended_at need to be filled in order to appear on customer invoice.</td>
+<tr>
+
+</table>
+
+##### Actions
+
+List all bills you have created and iterate through the list
+```ruby
+bills = Maestrano::Account::Bill.all
+bills.each { |b| puts b.id }
+```
+
+Access a single bill by id
+```ruby
+bill = Maestrano::Account::Bill.retrieve("bill-f1d2s54")
+puts bill.group_id
+```
+
+Create a new bill
+```ruby
+bill = Maestrano::Account::Bill.create(group_id: "cld-3", price_cents: 2000, description: "Product purchase")
+puts bill.id
+```
+
+Cancel a bill
+```ruby
+bill = Maestrano::Account::Bill.retrieve("bill-f1d2s54")
+bill.cancel
+```
+
+#### Recurring Bill
+A recurring bill charges a given customer at a regular interval without you having to do anything.
+
+```ruby
+Maestrano::Account::RecurringBill
+```
+
+##### Attributes
+
+<table>
+<tr>
+<th>Field</th>
+<th>Mode</th>
+<th>Type</th>
+<th>Required</th>
+<th>Default</th>
+<th>Description</th>
+<tr>
+
+<tr>
+<td><b>id</b></td>
+<td>readonly</td>
+<td>string</td>
+<td>-</td>
+<td>-</td>
+<td>The id of the recurring bill</td>
+<tr>
+
+<tr>
+<td><b>group_id</b></td>
+<td>read/write</td>
+<td>string</td>
+<td><b>Yes</b></td>
+<td>-</td>
+<td>The id of the group you are charging</td>
+<tr>
+
+<tr>
+<td><b>price_cents</b></td>
+<td>read/write</td>
+<td>Integer</td>
+<td><b>Yes</b></td>
+<td>-</td>
+<td>The amount in cents to charge to the customer</td>
+<tr>
+
+<tr>
+<td><b>description</b></td>
+<td>read/write</td>
+<td>String</td>
+<td><b>Yes</b></td>
+<td>-</td>
+<td>A description of the product billed as it should appear on customer invoice</td>
+<tr>
+
+<tr>
+<td><b>period</b></td>
+<td>read/write</td>
+<td>String</td>
+<td>-</td>
+<td>Month</td>
+<td>The unit of measure for the billing cycle. Must be one of the following: 'Day', 'Week', 'SemiMonth', 'Month', 'Year'</td>
+<tr>
+
+<tr>
+<td><b>frequency</b></td>
+<td>read/write</td>
+<td>Integer</td>
+<td>-</td>
+<td>1</td>
+<td>The number of billing periods that make up one billing cycle. The combination of billing frequency and billing period must be less than or equal to one year. If the billing period is SemiMonth, the billing frequency must be 1.</td>
+<tr>
+
+<tr>
+<td><b>cycles</b></td>
+<td>read/write</td>
+<td>Integer</td>
+<td>-</td>
+<td>nil</td>
+<td>The number of cycles this bill should be active for. In other words it's the number of times this recurring bill should charge the customer.</td>
+<tr>
+
+<tr>
+<td><b>start_date</b></td>
+<td>read/write</td>
+<td>Time</td>
+<td>-</td>
+<td>Now</td>
+<td>The date when this recurring bill should start billing the customer</td>
+<tr>
+
+<tr>
+<td><b>created_at</b></td>
+<td>readonly</td>
+<td>Time</td>
+<td>-</td>
+<td>-</td>
+<td>When the the bill was created</td>
+<tr>
+
+<tr>
+<td><b>currency</b></td>
+<td>read/write</td>
+<td>String</td>
+<td>-</td>
+<td>AUD</td>
+<td>The currency of the amount charged in <a href="http://en.wikipedia.org/wiki/ISO_4217#Active_codes">ISO 4217 format</a> (3 letter code)</td>
+<tr>
+
+<tr>
+<td><b>status</b></td>
+<td>readonly</td>
+<td>String</td>
+<td>-</td>
+<td>-</td>
+<td>Status of the recurring bill. Either 'pending', 'active', 'expired' or 'cancelled'.</td>
+<tr>
+
+</table>
+
+##### Actions
+
+List all recurring bills you have created and iterate through the list
+```ruby
+rec_bills = Maestrano::Account::RecurringBill.all
+rec_bills.each { |b| puts b.id }
+```
+
+Access a single recurring bill by id
+```ruby
+rec_bill = Maestrano::Account::RecurringBill.retrieve("rbill-f1d2s54")
+puts rec_bill.group_id
+```
+
+Create a new recurring bill
+```ruby
+rec_bill = Maestrano::Account::RecurringBill.create(group_id: "cld-3", price_cents: 2000, description: "Product purchase", period: 'Month', start_date: Time.now)
+puts rec_bill.id
+```
+
+Cancel a recurring bill
+```ruby
+rec_bill = Maestrano::Account::RecurringBill.retrieve("rbill-f1d2s54")
+rec_bill.cancel
+```
+
+
+## Support
+This README is still in the process of being written and improved. As such it might not cover some of the questions you might have.
+
+So if you have any question or need help integrating with us just let us know at support@maestrano.com
+
+## License
+
+MIT License. Copyright 2014 Maestrano Pty Ltd. https://maestrano.com
+
+You are not granted rights or licenses to the trademarks of Maestrano.

data/lib/maestrano.rb

@@ -58,6 +58,7 @@ module Maestrano
   def self.configure
     self.config ||= Configuration.new
     yield(config)
+    self.config.api_token = "#{self.config.app_id}:#{self.config.api_key}"
   end
   
   # Get configuration parameter value
@@ -69,12 +70,13 @@ module Maestrano
   end
 
   class Configuration
-    attr_accessor :environment, :api_key, :sso_enabled, 
+    attr_accessor :environment, :app_id, :api_key, :sso_enabled, 
       :app_host, :sso_app_init_path, :sso_app_consume_path, :user_creation_mode,
-      :verify_ssl_certs, :api_version
+      :verify_ssl_certs, :api_version, :api_token
 
     def initialize
       @environment = 'test'
+      @app_id = nil
       @api_key = nil
       @sso_enabled = true
       @app_host = 'http://localhost:3000'

data/lib/maestrano/account/bill.rb

@@ -5,8 +5,8 @@ module Maestrano
       include Maestrano::API::Operation::Create
 
       def cancel
-        response, api_key = Maestrano::API::Operation::Base.request(:delete, url, @api_key)
-        refresh_from(response, api_key)
+        response, api_token = Maestrano::API::Operation::Base.request(:delete, url, @api_token)
+        refresh_from(response, api_token)
         self
       end
     end

data/lib/maestrano/account/recurring_bill.rb

@@ -5,8 +5,8 @@ module Maestrano
       include Maestrano::API::Operation::Create
 
       def cancel
-        response, api_key = Maestrano::API::Operation::Base.request(:delete, url, @api_key)
-        refresh_from(response, api_key)
+        response, api_token = Maestrano::API::Operation::Base.request(:delete, url, @api_token)
+        refresh_from(response, api_token)
         self
       end
     end

data/lib/maestrano/api/list_object.rb

@@ -15,22 +15,22 @@ module Maestrano
         self.data.each(&blk)
       end
 
-      def retrieve(id, api_key=nil)
-        api_key ||= @api_key
-        response, api_key = Maestrano::API::Operation::Base.request(:get,"#{url}/#{CGI.escape(id)}", api_key)
-        Util.convert_to_maestrano_object(response, api_key)
+      def retrieve(id, api_token=nil)
+        api_token ||= @api_token
+        response, api_token = Maestrano::API::Operation::Base.request(:get,"#{url}/#{CGI.escape(id)}", api_token)
+        Util.convert_to_maestrano_object(response, api_token)
       end
 
-      def create(params={}, api_key=nil)
-        api_key ||= @api_key
-        response, api_key = Maestrano::API::Operation::Base.request(:post, url, api_key, params)
-        Util.convert_to_maestrano_object(response, api_key)
+      def create(params={}, api_token=nil)
+        api_token ||= @api_token
+        response, api_token = Maestrano::API::Operation::Base.request(:post, url, api_token, params)
+        Util.convert_to_maestrano_object(response, api_token)
       end
 
-      def all(params={}, api_key=nil)
-        api_key ||= @api_key
-        response, api_key = Maestrano::API::Operation::Base.request(:get, url, api_key, params)
-        Util.convert_to_maestrano_object(response, api_key)
+      def all(params={}, api_token=nil)
+        api_token ||= @api_token
+        response, api_token = Maestrano::API::Operation::Base.request(:get, url, api_token, params)
+        Util.convert_to_maestrano_object(response, api_token)
       end
     end
   end

data/lib/maestrano/api/object.rb

@@ -3,15 +3,15 @@ module Maestrano
     class Object
       include Enumerable
 
-      attr_accessor :api_key
-      @@permanent_attributes = Set.new([:api_key, :id])
+      attr_accessor :api_token
+      @@permanent_attributes = Set.new([:api_token, :id])
 
       # The default :id method is deprecated and isn't useful to us
       if method_defined?(:id)
         undef :id
       end
 
-      def initialize(id=nil, api_key=nil)
+      def initialize(id=nil, api_token=nil)
         # parameter overloading!
         if id.kind_of?(Hash)
           @retrieve_options = id.dup
@@ -21,7 +21,7 @@ module Maestrano
           @retrieve_options = {}
         end
 
-        @api_key = api_key
+        @api_token = api_token
         @values = {}
         # This really belongs in API::Resource, but not putting it there allows us
         # to have a unified inspect method
@@ -30,9 +30,9 @@ module Maestrano
         @values[:id] = id if id
       end
 
-      def self.construct_from(values, api_key=nil)
-        obj = self.new(values[:id], api_key)
-        obj.refresh_from(values, api_key)
+      def self.construct_from(values, api_token=nil)
+        obj = self.new(values[:id], api_token)
+        obj.refresh_from(values, api_token)
         obj
       end
 
@@ -45,8 +45,8 @@ module Maestrano
         "#<#{self.class}:0x#{self.object_id.to_s(16)}#{id_string}> JSON: " + JSON.pretty_generate(@values)
       end
 
-      def refresh_from(values, api_key, partial=false)
-        @api_key = api_key
+      def refresh_from(values, api_token, partial=false)
+        @api_token = api_token
 
         @previous_metadata = values[:metadata]
         removed = partial ? Set.new : Set.new(@values.keys - values.keys)
@@ -63,7 +63,7 @@ module Maestrano
           @unsaved_values.delete(k)
         end
         values.each do |k, v|
-          @values[k] = Util.convert_to_maestrano_object(v, api_key)
+          @values[k] = Util.convert_to_maestrano_object(v, api_token)
           @transient_values.delete(k)
           @unsaved_values.delete(k)
         end
@@ -102,12 +102,12 @@ module Maestrano
       end
 
       def _dump(level)
-        Marshal.dump([@values, @api_key])
+        Marshal.dump([@values, @api_token])
       end
 
       def self._load(args)
-        values, api_key = Marshal.load(args)
-        construct_from(values, api_key)
+        values, api_token = Marshal.load(args)
+        construct_from(values, api_token)
       end
 
       if RUBY_VERSION < '1.9.2'

data/lib/maestrano/api/operation/base.rb

@@ -3,7 +3,7 @@ module Maestrano
     module Operation
       module Base
         # class << self
-        #   attr_accessor :api_key, :api_base, :verify_ssl_certs, :api_version
+        #   attr_accessor :api_token, :api_base, :verify_ssl_certs, :api_version
         # end
         
         def self.api_url(url='')
@@ -11,8 +11,8 @@ module Maestrano
         end
         
         # Perform remote request
-        def self.request(method, url, api_key, params={}, headers={})
-          unless api_key ||= Maestrano.param('api_key')
+        def self.request(method, url, api_token, params={}, headers={})
+          unless api_token ||= Maestrano.param('api_token')
             raise Maestrano::API::Error::AuthenticationError.new('No API key provided.')
           end
 
@@ -37,7 +37,7 @@ module Maestrano
             payload = uri_encode(params)
           end
 
-          request_opts.update(:headers => request_headers(api_key).update(headers),
+          request_opts.update(:headers => request_headers(api_token).update(headers),
                               :method => method, :open_timeout => 30,
                               :payload => payload, :url => url, :timeout => 80)
 
@@ -63,7 +63,7 @@ module Maestrano
             handle_restclient_error(e)
           end
 
-          [parse(response), api_key]
+          [parse(response), api_token]
         end
 
         private
@@ -109,10 +109,10 @@ module Maestrano
             map { |k,v| "#{k}=#{Util.url_encode(v)}" }.join('&')
         end
 
-        def self.request_headers(api_key)
+        def self.request_headers(api_token)
           headers = {
             :user_agent => "Maestrano/v1 RubyBindings/#{Maestrano::VERSION}",
-            :authorization => "Basic #{Base64.encode64(api_key + ':')}",
+            :authorization => "Basic #{Base64.encode64(api_token)}",
             :content_type => 'application/x-www-form-urlencoded'
           }
 

data/lib/maestrano/api/operation/create.rb

@@ -3,9 +3,9 @@ module Maestrano
     module Operation
       module Create
         module ClassMethods
-          def create(params={}, api_key=nil)
-            response, api_key = Maestrano::API::Operation::Base.request(:post, self.url, api_key, params)
-            Util.convert_to_maestrano_object(response, api_key)
+          def create(params={}, api_token=nil)
+            response, api_token = Maestrano::API::Operation::Base.request(:post, self.url, api_token, params)
+            Util.convert_to_maestrano_object(response, api_token)
           end
         end
 

data/lib/maestrano/api/operation/delete.rb

@@ -3,8 +3,8 @@ module Maestrano
     module Operation
       module Delete
         def delete(params = {})
-          response, api_key = Maestrano::API::Operation::Base.request(:delete, url, @api_key, params)
-          refresh_from(response, api_key)
+          response, api_token = Maestrano::API::Operation::Base.request(:delete, url, @api_token, params)
+          refresh_from(response, api_token)
           self
         end
       end

data/lib/maestrano/api/operation/list.rb

@@ -3,9 +3,9 @@ module Maestrano
     module Operation
       module List
         module ClassMethods
-          def all(filters={}, api_key=nil)
-            response, api_key = Maestrano::API::Operation::Base.request(:get, url, api_key, filters)
-            Util.convert_to_maestrano_object(response, api_key)
+          def all(filters={}, api_token=nil)
+            response, api_token = Maestrano::API::Operation::Base.request(:get, url, api_token, filters)
+            Util.convert_to_maestrano_object(response, api_token)
           end
         end
 

data/lib/maestrano/api/operation/update.rb

@@ -12,8 +12,8 @@ module Maestrano
           if values.length > 0
             values.delete(:id)
 
-            response, api_key = Maestrano::API::Operation::Base.request(:put, url, @api_key, values)
-            refresh_from(response, api_key)
+            response, api_token = Maestrano::API::Operation::Base.request(:put, url, @api_token, values)
+            refresh_from(response, api_token)
           end
           self
         end

data/lib/maestrano/api/resource.rb

@@ -24,13 +24,13 @@ module Maestrano
       end
 
       def refresh
-        response, api_key = Maestrano::API::Operation::Base.request(:get, url, @api_key, @retrieve_options)
-        refresh_from(response, api_key)
+        response, api_token = Maestrano::API::Operation::Base.request(:get, url, @api_token, @retrieve_options)
+        refresh_from(response, api_token)
         self
       end
 
-      def self.retrieve(id, api_key=nil)
-        instance = self.new(id, api_key)
+      def self.retrieve(id, api_token=nil)
+        instance = self.new(id, api_token)
         instance.refresh
         instance
       end

data/lib/maestrano/api/util.rb

@@ -26,7 +26,7 @@ module Maestrano
         }
       end
 
-      def self.convert_to_maestrano_object(resp, api_key)
+      def self.convert_to_maestrano_object(resp, api_token)
         case resp
         when Array
           if resp.empty? || !resp.first[:object]
@@ -35,17 +35,17 @@ module Maestrano
             list = convert_to_maestrano_object({
               object: 'internal_list_object', 
               data:[],
-              url: convert_to_maestrano_object(resp.first, api_key).class.url
-            },api_key)
+              url: convert_to_maestrano_object(resp.first, api_token).class.url
+            },api_token)
             
             resp.each do |i|
-              list.data.push(convert_to_maestrano_object(i, api_key))
+              list.data.push(convert_to_maestrano_object(i, api_token))
             end
             list
           end
         when Hash
           # Try converting to a known object class.  If none available, fall back to generic Maestrano::API::Object
-          object_classes.fetch(resp[:object], Maestrano::API::Object).construct_from(resp, api_key)
+          object_classes.fetch(resp[:object], Maestrano::API::Object).construct_from(resp, api_token)
         else
           # Automatically parse iso8601 dates
           if resp =~ /\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}/

data/lib/maestrano/sso.rb

@@ -5,7 +5,7 @@ module Maestrano
     def self.saml_settings
       settings = Maestrano::Saml::Settings.new
       settings.assertion_consumer_service_url = self.consume_url
-      settings.issuer                         = Maestrano.param('api_key')
+      settings.issuer                         = Maestrano.param('app_id')
       settings.idp_sso_target_url             = self.idp_url
       settings.idp_cert_fingerprint           = Maestrano.param('sso_x509_fingerprint')
       settings.name_identifier_format         = Maestrano.param('sso_name_id_format')

data/lib/maestrano/version.rb

@@ -1,3 +1,3 @@
 module Maestrano
-  VERSION = '0.3.0'
+  VERSION = '0.4.0'
 end

data/test/helpers/api_helpers.rb

@@ -83,7 +83,7 @@ module APITestHelper
     }
   end
   
-  def test_invalid_api_key_error
+  def test_invalid_api_token_error
     {
       'success' => false,
       'data' => {},

data/test/maestrano/account/bill_test.rb

@@ -30,8 +30,8 @@ module Maestrano
 
 
       should "should successfully create a remote bill when passed correct parameters" do
-        @api_mock.expects(:post).with do |url, api_key, params|
-          url == "#{Maestrano.param('api_host')}#{Maestrano.param('api_base')}account/bills" && api_key.nil? && 
+        @api_mock.expects(:post).with do |url, api_token, params|
+          url == "#{Maestrano.param('api_host')}#{Maestrano.param('api_base')}account/bills" && api_token.nil? && 
           CGI.parse(params) == {"group_id"=>["cld-1"], "price_cents"=>["23000"], "currency"=>["AUD"], "description"=>["Some bill"]}
         end.once.returns(test_response(test_account_bill))
 

data/test/maestrano/account/recurring_bill_test.rb

@@ -30,8 +30,8 @@ module Maestrano
 
 
       should "successfully create a remote bill when passed correct parameters" do
-        @api_mock.expects(:post).with do |url, api_key, params|
-          url == "#{Maestrano.param('api_host')}#{Maestrano.param('api_base')}account/recurring_bills" && api_key.nil? && 
+        @api_mock.expects(:post).with do |url, api_token, params|
+          url == "#{Maestrano.param('api_host')}#{Maestrano.param('api_base')}account/recurring_bills" && api_token.nil? && 
           CGI.parse(params) == {"group_id"=>["cld-1"], "price_cents"=>["23000"], "currency"=>["AUD"], "description"=>["Some recurring bill"], "period"=>["Month"]}
         end.once.returns(test_response(test_account_recurring_bill))
 

data/test/maestrano/api/object_test.rb

@@ -20,7 +20,7 @@ module Maestrano
         m = Marshal.load(Marshal.dump(obj))
         assert_equal 1, m.id
         assert_equal 'Maestrano', m.name
-        assert_equal 'apikey', m.api_key
+        assert_equal 'apikey', m.api_token
         assert_equal date.iso8601, m.some_date.iso8601
       end
     end

data/test/maestrano/api/resource_test.rb

@@ -35,7 +35,7 @@ module Maestrano
       end
 
       should "specifying invalid api credentials should raise an exception" do
-        response = test_response(test_invalid_api_key_error, 401)
+        response = test_response(test_invalid_api_token_error, 401)
         assert_raises Maestrano::API::Error::AuthenticationError do
           @api_mock.expects(:get).once.raises(RestClient::ExceptionWithResponse.new(response, 401))
           Maestrano::Account::Bill.retrieve("failing_bill")
@@ -43,7 +43,7 @@ module Maestrano
       end
 
       should "AuthenticationErrors should have an http status, http body, and JSON body" do
-        response = test_response(test_invalid_api_key_error, 401)
+        response = test_response(test_invalid_api_token_error, 401)
         begin
           @api_mock.expects(:get).once.raises(RestClient::ExceptionWithResponse.new(response, 401))
           Maestrano::Account::Bill.retrieve("failing_bill")
@@ -51,7 +51,7 @@ module Maestrano
           assert_equal(401, e.http_status)
           assert_equal(true, !!e.http_body)
           assert_equal(true, !!e.json_body[:errors])
-          assert_equal(test_invalid_api_key_error['errors'].first.join(" "), e.json_body[:errors].first.join(" "))
+          assert_equal(test_invalid_api_token_error['errors'].first.join(" "), e.json_body[:errors].first.join(" "))
         end
       end
 
@@ -68,7 +68,7 @@ module Maestrano
           
           should "use the per-object credential when creating" do
             Maestrano::API::Operation::Base.expects(:execute_request).with do |opts|
-              opts[:headers][:authorization] == "Basic #{Base64.encode64('sk_test_local:')}"
+              opts[:headers][:authorization] == "Basic #{Base64.encode64('someid:somekey')}"
             end.returns(test_response(test_account_bill))
 
             Maestrano::Account::Bill.create({
@@ -77,7 +77,7 @@ module Maestrano
                 currency: 'AUD',
                 description: 'Some bill'
               },
-              'sk_test_local'
+              'someid:somekey'
             )
           end
         end
@@ -85,7 +85,7 @@ module Maestrano
         context "with a global API key set" do
           should "use the per-object credential when creating" do
             Maestrano::API::Operation::Base.expects(:execute_request).with do |opts|
-              opts[:headers][:authorization] == "Basic #{Base64.encode64('local:')}"
+              opts[:headers][:authorization] == "Basic #{Base64.encode64('someid:somekey')}"
             end.returns(test_response(test_account_bill))
 
             Maestrano::Account::Bill.create({
@@ -94,7 +94,7 @@ module Maestrano
                 currency: 'AUD',
                 description: 'Some bill'
               },
-              'local'
+              'someid:somekey'
             )
           end
         end
@@ -159,7 +159,7 @@ module Maestrano
         end
 
         should "setting a nil value for a param should exclude that param from the GET request" do
-          @api_mock.expects(:get).with do |url, api_key, params|
+          @api_mock.expects(:get).with do |url, api_token, params|
             uri = URI(url)
             query = CGI.parse(uri.query)
             (url =~ %r{^#{Maestrano.param('api_host')}#{Maestrano.param('api_base')}account/bills?} &&
@@ -169,9 +169,9 @@ module Maestrano
         end
         
         should "setting a nil value for a param should exclude that param from the POST request" do
-          @api_mock.expects(:post).with do |url, api_key, params|
+          @api_mock.expects(:post).with do |url, api_token, params|
             url == "#{Maestrano.param('api_host')}#{Maestrano.param('api_base')}account/bills" &&
-              api_key.nil? &&
+              api_token.nil? &&
               CGI.parse(params) == { 'group_id' => ['cld-1'], 'price_cents' => ['23000'], 'currency' => ['AUD'] }
           end.returns(test_response(test_account_bill))
           Maestrano::Account::Bill.create({
@@ -241,9 +241,9 @@ module Maestrano
         # end
 
         should "updating an object should issue a PUT request with only the changed properties" do
-          @api_mock.expects(:put).with do |url, api_key, params|
+          @api_mock.expects(:put).with do |url, api_token, params|
             url == "#{Maestrano.param('api_host')}#{Maestrano.param('api_base')}account/bills/bill-1" && 
-            api_key.nil? && CGI.parse(params) == {'description' => ['another_mn']}
+            api_token.nil? && CGI.parse(params) == {'description' => ['another_mn']}
           end.once.returns(test_response(test_account_bill))
           
           c = Maestrano::Account::Bill.construct_from(test_account_bill[:data])

data/test/maestrano/maestrano_test.rb

@@ -45,5 +45,10 @@ class MaestranoTest < Test::Unit::TestCase
         assert Maestrano.param(parameter) == Maestrano::Configuration::EVT_CONFIG[:production][parameter.to_sym]
       end
     end
+    
+    should "build the api_token based on the app_id and api_key" do
+      Maestrano.configure { |config| config.app_id = "bla"; config.api_key = "blo" }
+      assert_equal "bla:blo", Maestrano.param(:api_token)
+    end
   end
 end

data/test/maestrano/sso_test.rb

@@ -40,7 +40,7 @@ module Maestrano
     should "return the right saml_settings" do
       settings = Maestrano::SSO.saml_settings
       assert settings.assertion_consumer_service_url == Maestrano::SSO.consume_url
-      assert settings.issuer == Maestrano.param('api_key')
+      assert settings.issuer == Maestrano.param('app_id')
       assert settings.idp_sso_target_url == Maestrano::SSO.idp_url
       assert settings.idp_cert_fingerprint == Maestrano.param('sso_x509_fingerprint')
       assert settings.name_identifier_format == Maestrano.param('sso_name_id_format')

data/test/test_helper.rb

@@ -38,6 +38,7 @@ class Test::Unit::TestCase
     @api_mock = mock('api_mock')
     Maestrano::API::Operation::Base.mock_rest_client = @api_mock
     Maestrano.configure do |config|
+      config.app_id = "app-1"
       config.api_key = "g15354F34f3x5z"
       config.environment = 'production'
     end

metadata

@@ -2,7 +2,7 @@
 name: maestrano
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors: 
 - Arnaud Lachaume
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2014-05-29 00:00:00 Z
+date: 2014-05-31 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rest-client