cloudability 0.0.5 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 089d78278f2d92caf434767c88c8d04ed8c95ecc
-  data.tar.gz: d918cba1038ea27011947c1c18df94e714dca66b
+  metadata.gz: 97772a04d10ae950a9ac8b6c7f821bf6a43fbbe6
+  data.tar.gz: 48ba113fcd25cc19921743f5fa6304b069897589
 SHA512:
-  metadata.gz: e03406715373ac541fbef6f58b8b525396f812be03f8999966c69ebcefadc7ef61e1d9d536a77ff9b9b0111d65689bf99780b70e9d8f8158235910ac876f60ec
-  data.tar.gz: cd06e24b5b8d9e7c5d68dc5f8f93d840e854a89896a2a3c214e33c62523d3c11713b8c450a388b78f898f83f4c59a630b12f24adba34f0c9b6470335543dd3cc
+  metadata.gz: a166392737fe8d90c66b8345e43cb3f4b29266291682f7c5d64cb81742c4784e214f662b23b5f725a079ca4cb45d07dad6241b3a11e832d5c0648afe69510ba3
+  data.tar.gz: 5945d472dce52218f9c54addec0f4cfb588bd94d92e8a86cff02b9d012b9eaea08612e364408e54d99f5214faae6436bcd2efa1b35f00812e1b1f0ae05ecbc50

data/README.md

@@ -1,6 +1,13 @@
+Cloudability
+===
+
 [![Build Status](https://travis-ci.org/ColbyAley/cloudability.png?branch=master)](https://travis-ci.org/ColbyAley/cloudability)
+[![Code Climate](https://codeclimate.com/github/ColbyAley/cloudability.png)](https://codeclimate.com/github/ColbyAley/cloudability)
+[![Coverage Status](https://coveralls.io/repos/ColbyAley/cloudability/badge.png)](https://coveralls.io/r/ColbyAley/cloudability)
+
+Ruby wrapper for the [Cloudability API](http://developers.cloudability.com/). Supports most of the public API endpoints, including some legacy ones such as bugets. Converts JSON responses to objects with Hashie::Mash.
 
-Ruby wrapper for the [Cloudability API](http://developers.cloudability.com/).
+This is the README for version 0.1.0 of the gem. v0.1.0 introduces a radically different interface. If you're still on v0.0.5, please refer to it's [README](https://github.com/ColbyAley/cloudability/tree/v0.0.5).
 
 ## Installation
 
@@ -19,34 +26,61 @@ Or install it yourself as:
 ## Usage
 
   Supported endpoints:
+
   * Credentials
-  * Budgets
-  * Reporting
   * Organizations (Including invitations and roles.)
+  * Budgets
+  * Billing Reports
+  * Cost Reporrts
+  * Usage Reports
+
+You will need to generate an API token to use the API. Read more [here](https://support.cloudability.com/hc/en-us/articles/200311933-API-Setup-and-Documentation).
 
 Feel free to shoot me an email at colby@cloudability.com if you have any questions or need help.
   
-### Credentials
-  Retrieve an array containing all your Cloud Accounts.
+### Examples
+
+    @client = Cloudability::Client.new(auth_token: 'auth_token')
+
+#### Credentials
+
+    credentials = @client.credentials # Get all of your connected credentials
+    puts first_account.last.account_created_at
+    puts credentials.first.account_identifier
+
+#### Organizations
+
+    @client.invite_user('colby@cloudability.com', name: 'Colby Aley') # Invite a user to your org
+    @client.delete_invite(1) # Delete invite 1
+    @client.update_invite(103,1) # Update invitation 103 to have role id 1
+    @client.my_organization # Get info about your org
+    @client.organization_invitations # List invitations for your org
+    @client.organization_roles # List roles for your org
+
+#### Budgets
+
+    @client.budgets # List your current budgets
+
+#### Billing Reports
+
+    @client.billing_report # Generate a report of your spend
+    @client.billing_report(vendor: 'Amazon', by: 'period')
+    @client.billing_report(by: 'vendor')
 
-    credentials = Cloudability::Credentials.new(auth_token: 'xxxxxxxxxxxxxxxxxxxx')
-    all_credentials = credentials.find_all
+#### Cost Reports
 
-    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
+    @client.cost_reports # List cost reports
+    @client.cost_measures # List measures supported by server
+    @client.cost_filters # List filters supported by the server
 
-### Organizations
+#### Usage Reports
 
-    c = Cloudability::Organizations.new(auth_token: 'xxxxxxxxxxxxxxxxxxxx')
-    c.invite_user(email: 'colby@cloudability.com', name: 'Colby Aley')
-    c.roles
-    c.invitations
+    @client.usage_reports # List usage reports
+    @client.usage_measures # List measures supported by server
+    @client.usage_filters # List filters supported by the server
 
 ## TODO:
-  * More tests!
+  * Better tests!
   * More endpoints!
   * More awesomeness!
 

data/cloudability.gemspec

@@ -23,4 +23,5 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency('rspec')
   gem.add_development_dependency('fakeweb')
   gem.add_development_dependency('rake', '~> 0.6')
+  gem.add_development_dependency('coveralls')
 end

data/lib/cloudability.rb

@@ -1,9 +1,70 @@
 require 'httparty'
 require 'hashie'
 
-require 'cloudability/billing'
-require 'cloudability/budgets'
-require 'cloudability/credentials'
-require 'cloudability/organizations'
+require 'cloudability/client/billing_reports'
+require 'cloudability/client/cost_reports'
+require 'cloudability/client/usage_reports'
+require 'cloudability/client/budgets'
+require 'cloudability/client/credentials'
+require 'cloudability/client/organizations'
 
 require 'cloudability/version'
+
+
+module Cloudability
+  class Client
+    include Cloudability::Client::BillingReports
+    include Cloudability::Client::UsageReports
+    include Cloudability::Client::CostReports
+    include Cloudability::Client::Budgets
+    include Cloudability::Client::Credentials
+    include Cloudability::Client::Organizations
+    include HTTParty
+
+    def initialize(options={})
+      raise ArgumentError, "You must provide an auth token" if options[:auth_token].nil?
+      @auth_token = options[:auth_token]
+    end
+
+    base_uri 'https://app.cloudability.com/api'
+
+    private
+
+    def get(url, params={})
+      response = self.class.get(url, options(query: params))
+      response.success? ? response : raise(response.response)
+    end
+
+    def post(url, params={})
+      response = self.class.post(url, options(query: params))
+      response.success? ? response : raise(response.response)
+    end
+
+    def put(url, params={})
+      response = self.class.put(url, options(query: params))
+      response.success? ? response : raise(response.response)
+    end
+
+    def delete(url, params={})
+      response = self.class.delete(url, options(query: params))
+      response.success? ? response : raise(response.response)
+    end
+
+    # Convert the an array of hashes into an array of Mashes!
+    #
+    # @param [String] array of hashes.
+    # @return [Array] array of Hashie::Mashes
+    def convert_to_mashes(array)
+      array.map { |element| Hashie::Mash.new(element) }
+    end
+
+    def options(o={})
+      o[:query] ||= {}
+      o[:headers] ||= {}
+      o[:headers]['User-Agent'] = "Cloudability-Ruby #{Cloudability::VERSION}"
+      o[:query][:auth_token] = @auth_token
+      o
+    end
+
+  end
+end

data/lib/cloudability/client/billing_reports.rb

@@ -0,0 +1,22 @@
+module Cloudability
+  class Client
+    module BillingReports
+
+      # Generate a report of your spend
+      #
+      # @param [Hash] optional parameters
+      # @return [Array] array of Hashie::Mashes
+      # @see http://developers.cloudability.com/resources/billing_reports/
+      # @example generate report
+      #   .billing_report(vendor: 'Amazon')
+      #   .billing_report(by: 'vendor')
+      #   .billing_report(by: 'service', vendor: 'Amazon', period: '2012-03-01')
+      def billing_report(options={})
+        request = get '/1/billing_reports', options
+        convert_to_mashes request
+      end
+      alias :billing_reports :billing_report
+      
+    end
+  end
+end

data/lib/cloudability/client/budgets.rb

@@ -0,0 +1,15 @@
+module Cloudability
+  class Client
+    module Budgets
+
+      # Retrieve information about your budgets
+      #
+      # @return [Array] array of Hashie::Mashes
+      def budgets
+        request = get '/1/budgets/index'
+        convert_to_mashes(request)
+      end
+      
+    end
+  end
+end

data/lib/cloudability/client/cost_reports.rb

@@ -0,0 +1,33 @@
+module Cloudability
+  class Client
+    module CostReports
+
+      # List current cost reports
+      #
+      # @see http://developers.cloudability.com/resources/cost/
+      # @return [Array] array of Hashie::Mashes
+      def cost_reports
+        response = get '/1/reporting/cost'
+        convert_to_mashes response
+      end
+
+      # List measures recognized by the server
+      #
+      # @see http://developers.cloudability.com/resources/cost/
+      # @return [Array] array of Hashie::Mashes
+      def cost_measures
+        response = get '/1/reporting/cost/measures'
+        convert_to_mashes response
+      end
+
+      # List available filters for requesting data
+      #
+      # @see http://developers.cloudability.com/resources/cost/
+      # @return [Array] array of filters as strings
+      def cost_filters
+        get('/1/reporting/cost/filters').to_a
+      end
+      
+    end
+  end
+end

data/lib/cloudability/client/credentials.rb

@@ -0,0 +1,15 @@
+module Cloudability
+  class Client
+    module Credentials
+
+      # Get information about your configured credentials
+      #
+      # @return [Array] array of Hashie::Mashes
+      def credentials
+        request = get '/0/credentials/index'
+        convert_to_mashes request
+      end
+      
+    end
+  end
+end

data/lib/cloudability/client/organizations.rb

@@ -0,0 +1,76 @@
+module Cloudability
+  class Client
+    module Organizations
+
+      # Get information about the authenticted user's organization
+      # NOTE: This requires that you are the organization admin.
+      # 
+      # @return [Hashie::Mash]
+      def my_organization
+        request = get '/1/organizations'
+        Hashie::Mash.new request
+      end
+      alias :organization :my_organization
+
+      # List all invitations to the authenticated user's organization
+      #
+      # @see http://developers.cloudability.com/resources/organizations/invitations/
+      # @return [Array] array of Hashie::Mashes
+      def organization_invitations
+        request = get '/1/organizations/invitations'
+        convert_to_mashes request
+      end
+      alias :invitations :organization_invitations
+
+      # Retrieve your organizations roles.
+      #
+      # @return [Array] array of Hashie::Mashes
+      def organization_roles
+        request = get '/1/organizations/roles'
+        convert_to_mashes request
+      end
+      alias :roles :organization_roles
+
+      # Create a new invitation to the authenticated user's organization
+      #
+      # @see http://developers.cloudability.com/resources/organizations/invitations/
+      # @param [String] email to send invitation to
+      # @param [Hash] args to pass to HTTParty
+      #   @option [String] name
+      #   @option [String] role_id
+      def invite_user(email, options={})
+        options[:email] = email
+
+        request = post '/1/organizations/invitations', options
+        Hashie::Mash.new request
+      end
+      alias :invite :invite_user
+
+      # Delete an invitation to the authenticated user's organization
+      #
+      # @see http://developers.cloudability.com/resources/organizations/invitations/
+      # @param [Integer] id of the invitation
+      # @return 
+      def delete_invite(id)
+        request = delete "/1/organizations/invitations/#{id}"
+        Hashie::Mash.new request
+      end
+      alias :delete_invitation :delete_invite
+
+      # Update a user's invitation to an organization.
+      #
+      # @see http://developers.cloudability.com/resources/organizations/invitations/
+      # @param [Integer] id to update
+      # @param [Integer] role id to assign to invite
+      # @return [Hashie::Mash]
+      def update_invite(id, role_id)
+        options = {}
+        options[:role_id] = role_id
+
+        request = put "/1/organizations/invitations/#{id}", options
+        Hashie::Mash.new request
+      end
+      alias :update_invitation :update_invite
+    end
+  end
+end

data/lib/cloudability/client/usage_reports.rb

@@ -0,0 +1,33 @@
+module Cloudability
+  class Client
+    module UsageReports
+
+      # List current usage reports.
+      #
+      # @see http://developers.cloudability.com/resources/usage/
+      # @return [Array] array of Hashie::Mashes
+      def usage_reports
+        request = get '/1/reporting'
+        convert_to_mashes request
+      end
+
+      # List measures recognized by the server
+      #
+      # @see http://developers.cloudability.com/resources/usage/
+      # @return [Array] array of Hashie::Mashes
+      def usage_measures
+        request = get '/1/reporting/measures'
+        convert_to_mashes request
+      end
+
+      # List available filters for requesting data
+      #
+      # @see http://developers.cloudability.com/resources/usage/
+      # @return [Array] array of filters as strings
+      def usage_filters
+        get('/1/reporting/filters').to_a
+      end
+      
+    end
+  end
+end

data/lib/cloudability/version.rb

@@ -1,3 +1,3 @@
 module Cloudability
-  VERSION = "0.0.5"
+  VERSION = '0.1.0'
 end

data/spec/cloduability/billing_spec.rb

@@ -1,53 +1,35 @@
 require 'spec_helper'
 
-describe Cloudability::Billing do
-  describe '#initialize' do
-    it 'should raise ArgumentError when auth_token is not provided' do
-      expect { Cloudability::Billing.new }.to raise_exception(ArgumentError)
-    end
-
-    it 'should not raise any exception when auth token is provided' do
-      expect { Cloudability::Billing.new(auth_token: 'token') }.not_to raise_exception
-    end
-  end
+describe Cloudability::Client::BillingReports do
 
   before do
-    @cloudability = Cloudability::Billing.new(auth_token: 'token')
+    @client = Cloudability::Client.new(auth_token: 'token')
   end
-  
-  describe '#report_by' do
-    it 'should raise an ArgumentError when no dimension is passed' do
-      expect { @cloudability.report_by }.to raise_exception(ArgumentError)
-    end
-
-    it 'should raise an ArgumentError when unknown dimension is passed' do
-      expect { @cloudability.report_by(:coolness) }.to raise_exception(ArgumentError)
-    end
 
+  describe '#billing_reports' do
     it 'should be an array' do
-      stub_get('/0/billing_reports?auth_token=token&by=account', 'report_by_account')
-      @cloudability.report_by(:account).class.should == Array
+      stub_get('/1/billing_reports?auth_token=token', 'billing_reports')
+      @client.billing_report.should be_kind_of Array
     end
 
     it 'should be an array of Hashie::Mashes' do
-      stub_get('/0/billing_reports?auth_token=token&by=account', 'report_by_account')
-      @cloudability.report_by(:account).each{|report| report.class.should == Hashie::Mash }
+      stub_get('/1/billing_reports?auth_token=token', 'billing_reports')
+      @client.billing_report.each{|report| report.should be_kind_of Hashie::Mash }
     end
-  end
 
-  describe '#filter_by_period' do
-    it 'should get a report given a period' do
-      stub_get('/0/billing_reports?auth_token=token&period=13-08-05', 'report_by_period')
-      expect { @cloudability.filter_by_period('13-08-05') }.not_to raise_exception
+    it 'should have a currency attrubute on every element' do
+      stub_get('/1/billing_reports?auth_token=token', 'billing_reports')
+      @client.billing_report.each{|report| report.currency.should_not be_nil }
     end
 
-    it 'should be a Hashie::Mash' do
-      stub_get('/0/billing_reports?auth_token=token&period=13-08-05', 'report_by_period')
-      @cloudability.filter_by_period('13-08-05').class.should == Hashie::Mash
+    it 'should return results by service' do
+      stub_get('/1/billing_reports?auth_token=token&by=service', 'billing_reports')
+      expect { @client.billing_report(by: 'service') }.not_to raise_exception
     end
 
-    it 'should raise an ArgumentError when an invalid date is provided' do
-      expect { @cloudability.filter_by_period('1343-08-05') }.to raise_exception(ArgumentError)
+    it 'should return results given by service, given the vendor and period' do
+      stub_get('/1/billing_reports?auth_token=token&by=service&vendor=Amazon&period=2012-03-01', 'billing_reports')
+      expect { @client.billing_report(by: 'service', vendor: 'Amazon', period: '2012-03-01') }.not_to raise_exception
     end
   end
 end