Moar docs, and support for inviting org members

Author: cp

README.md

@@ -30,20 +30,17 @@ Feel free to shoot me an email at colby@cloudability.com if you have any questio
 
     credentials = Cloudability::Credentials.new(auth_token: 'xxxxxxxxxxxxxxxxxxxx')
     all_credentials = credentials.find_all
-    first_account = all_credentials.first
 
     puts first_account.account_created_at
     puts first_account.account_identifier
     puts first_account.created_at
     puts first_account.has_auth
     puts first_account.has_estimate
-    puts first_account.id
-    puts first_account.is_duplicate
-    puts first_account.nickname
-    puts first_account.state
-    puts first_account.updated_at
-    puts first_account.vendor_id
-    puts first_account.vendor_key
+
+### Organizations
+
+    c = Cloudability::Organizations.new(auth_token: 'xxxxxxxxxxxxxxxxxxxx')
+    c.invite_user(email: 'colby@cloudability.com', name: 'Colby Aley')
 
 ## TODO:
   * More tests!

lib/cloudability/billing.rb

@@ -14,6 +14,9 @@ def initialize(options={})
     end
 
     # Define which dimension the billing report will return.
+    #
+    # @param [Symbol] dimension to report on.
+    # @return [Array] array of Hashie::Mashes
     def report_by(dimension)
       case dimension
       when :account
@@ -49,6 +52,9 @@ def filter_by_period(period)
 
     private
 
+    # GET a URL with HTTParty
+    #
+    # @param [Array] array of URL params to pass to HTTParty
     def get_url(params)
       joined_param = params.join
       response = self.class.get("/billing_reports?auth_token=#{@auth_token}#{joined_param}")

lib/cloudability/budgets.rb

@@ -49,7 +49,10 @@ def get_budgets
       response.success? ? response : raise(response.response)
     end
 
-    # Convert the json into an Array of Mashes.
+    # Convert the JSON into an Array of Mashes.
+    #
+    # @param [String] JSON array
+    # @return [Array] array of Hashie::Mashes
     def convert_to_mashes(response)
       response.map { |budget| Hashie::Mash.new(budget) }
     end

lib/cloudability/credentials.rb

@@ -22,7 +22,10 @@ def get_credentials
       response.success? ? response : raise(response.response)
     end
 
-    # Convert the json into an Array of Mashes.
+    # Convert the JSON into an Array of Mashes.
+    #
+    # @param [String] JSON array
+    # @return [Array] array of Hashie::Mashes
     def convert_to_mashes(response)
       response.map { |credential| Hashie::Mash.new(credential) }
     end

lib/cloudability/organizations.rb

@@ -1,3 +1,5 @@
+require 'json'
+
 module Cloudability
   class Organizations
     include HTTParty
@@ -13,15 +15,54 @@ def initialize(options={})
     end
 
     def my_organization
-      Hashie::Mash.new(get_my_organization)
+      response = get_url("/organizations?auth_token=#{@auth_token}")
+      Hashie::Mash.new(response)
+    end
+
+    def invitations
+      response = get_url("/organizations/invitations?auth_token=#{@auth_token}")
+      convert_to_mashes(response)
+    end
+
+    # Invite a user to your organization
+    #
+    # @param [Hash] args to pass to HTTParty
+    #   @option [String] email (required)
+    #   @option [String] name
+    #   @option [String] role_id
+    def invite_user(args)
+      raise ArgumentError, "You must provide an email" if args[:email].nil?
+
+      response = post_url("/organizations/invitations?auth_token=#{@auth_token}", args)
+      Hashie::Mash.new(response)
     end
 
     private
 
-    def get_my_organization
-      response = self.class.get("/organizations?auth_token=#{@auth_token}")
+    # POST a URL with HTTParty
+    #
+    # @param [String] URL to post
+    # @param [Hash] params to pass to HTTParty
+    def post_url(url, params={})
+      response = self.class.post(url, query: params)
       response.success? ? response : raise(response.response)
     end
 
+    # GET a URL with HTTParty
+    #
+    # @param [String] URL to get
+    def get_url(url)
+      response = self.class.get(url)
+      response.success? ? response : raise(response.response)
+    end
+
+    # Convert the JSON into an Array of Mashes.
+    #
+    # @param [String] JSON array
+    # @return [Array] array of Hashie::Mashes
+    def convert_to_mashes(response)
+      response.map { |budget| Hashie::Mash.new(budget) }
+    end
+
   end
 end

spec/cloduability/organizations_spec.rb

@@ -21,4 +21,32 @@
       @cloudability.my_organization.class.should == Hashie::Mash
     end
   end
+
+  describe '#invitations' do
+    it 'should be an Array' do
+      stub_get('/1/organizations/invitations?auth_token=token', 'organization_invitations')
+      @cloudability.invitations.class.should == Array
+    end
+
+    it 'should be an array of Hashie::Mashes' do
+      stub_get('/1/organizations/invitations?auth_token=token', 'organization_invitations')
+      @cloudability.invitations.each{|invite| invite.class.should == Hashie::Mash }
+    end
+  end
+
+  describe '#invite_user' do
+    it 'should be a Hashie::Mash' do
+      stub_post('/1/organizations/invitations?auth_token=token&email=colbyaleyrb%40gmail.com', 'organization_invitation')
+      @cloudability.invite_user(email: 'colbyaleyrb@gmail.com').class.should == Hashie::Mash
+    end
+
+    it 'should accept a hash with email and name' do
+      stub_post('/1/organizations/invitations?auth_token=token&email=colbyaleyrb%40gmail.com&name=colby', 'organization_invitation')
+      expect { @cloudability.invite_user(email: 'colbyaleyrb@gmail.com', name: 'colby') }.not_to raise_exception
+    end
+
+    it 'should not accept requests without an email' do
+      expect { @cloudability.invite_user(name: 'Colby Aley') }.to raise_exception(ArgumentError)
+    end
+  end
 end

spec/fixtures/organization_invitation

@@ -0,0 +1,18 @@
+HTTP/1.1 201 Created
+Server: nginx/1.4.4
+Date: Wed, 25 Dec 2013 05:47:18 GMT
+Content-Type: application/json
+Content-Length: 318
+Connection: keep-alive
+Status: 201 Created
+Strict-Transport-Security: max-age=31536000
+Set-Cookie: _mkra_ctxt=379f814d012ea011e3b06a9d27c08589--201; path=/; secure
+X-UA-Compatible: IE=Edge,chrome=1
+ETag: "315d11c00c3c098a8b232bdc46310b93"
+Cache-Control: max-age=0, private, must-revalidate
+X-Request-Id: eada05630363230c2942dd46f0561cf2
+X-Runtime: 1.487748
+X-Rack-Cache: invalidate, pass
+Origin: app.cloudability.com
+
+{"id":10427,"state":"pending","user":{"id":10505,"full_name":null,"email":"colbyaleyrb@gmail.com","default_filter_set_id":null,"is_organization_admin":false,"currency":{"key":"usd","symbol":"$","symbol_first":true,"thousands_separator":",","decimal_mark":"."}},"organization_role":{"id":2,"key":"user","label":"User"}}

spec/fixtures/organization_invitations

@@ -0,0 +1,18 @@
+HTTP/1.1 200 OK
+Server: nginx/1.4.4
+Date: Wed, 25 Dec 2013 04:46:40 GMT
+Content-Type: application/json
+Content-Length: 746
+Connection: keep-alive
+Status: 200 OK
+Strict-Transport-Security: max-age=31536000
+Set-Cookie: _mkra_ctxt=53ec8b9512d2efe39fd059709c8ad35c--200; path=/; secure
+X-UA-Compatible: IE=Edge,chrome=1
+ETag: "55e062e7527926f54559b0e2ad810915"
+Cache-Control: max-age=0, private, must-revalidate
+X-Request-Id: 2f5a92d8db37da8e719265cf74866386
+X-Runtime: 0.151318
+X-Rack-Cache: miss
+Origin: app.cloudability.com
+
+[{"id":10424,"state":"pending","user":{"id":10502,"full_name":"Cudi Aley","email":"ayycudi@aley.me","default_filter_set_id":null,"is_organization_admin":false,"currency":{"key":"usd","symbol":"$","symbol_first":true,"thousands_separator":",","decimal_mark":"."},"is_enterprise":true,"ri_az_transfer_beta":false},"organization_role":{"id":2,"key":"user","label":"User"}},{"id":1548,"state":"accepted","user":{"id":5902,"full_name":"Colby Aley","email":"colby@aley.me","default_filter_set_id":null,"is_organization_admin":true,"currency":{"key":"usd","symbol":"$","symbol_first":true,"thousands_separator":",","decimal_mark":"."},"is_enterprise":true,"ri_az_transfer_beta":false},"organization_role":{"id":1,"key":"admin","label":"Administrator"}}]