cloudability 0.0.1 → 0.0.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 089d78278f2d92caf434767c88c8d04ed8c95ecc
+  data.tar.gz: d918cba1038ea27011947c1c18df94e714dca66b
+SHA512:
+  metadata.gz: e03406715373ac541fbef6f58b8b525396f812be03f8999966c69ebcefadc7ef61e1d9d536a77ff9b9b0111d65689bf99780b70e9d8f8158235910ac876f60ec
+  data.tar.gz: cd06e24b5b8d9e7c5d68dc5f8f93d840e854a89896a2a3c214e33c62523d3c11713b8c450a388b78f898f83f4c59a630b12f24adba34f0c9b6470335543dd3cc

data/.gitignore

@@ -2,6 +2,7 @@
 *.rbc
 .bundle
 .config
+.rspec
 .yardoc
 Gemfile.lock
 InstalledFiles

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 1.9.2
+  - 1.9.3
+  - 2.0.0

data/Gemfile

@@ -1,12 +1,4 @@
-source :rubygems
-gem 'httparty'
-gem 'mash'
+# Gem's dependencies are in cloudability.gemspec
+source "https://rubygems.org"
+gemspec
 
-group :test do
-  gem 'turn'
-  gem 'rake'
-
-  gem 'shoulda'
-  gem 'fakeweb'
-  gem 'jnunemaker-matchy'
-end

data/LICENSE.txt

@@ -1,22 +1,21 @@
-Copyright (c) 2012 Aaron Bento
+The MIT License (MIT)
 
-MIT License
+Copyright (c) 2012-2014 Aaron Bento & Colby Aley
 
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
 
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -1,6 +1,6 @@
-# Cloudability
+[![Build Status](https://travis-ci.org/ColbyAley/cloudability.png?branch=master)](https://travis-ci.org/ColbyAley/cloudability)
 
-Ruby wrapper for the Cloudability API using httparty.
+Ruby wrapper for the [Cloudability API](http://developers.cloudability.com/).
 
 ## Installation
 
@@ -18,38 +18,37 @@ Or install it yourself as:
 
 ## Usage
 
-  Covers endpoints:
-  * credentials
-  * budgets
-  * and partial billing_reports
-  
+  Supported endpoints:
+  * Credentials
+  * Budgets
+  * Reporting
+  * Organizations (Including invitations and roles.)
 
-### Credential Endpoint:
-  Caputure an array containing all your Cloud Accounts 
+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.
 
-    credentials = Cloudability::Credentials.new(:auth_token => 'xxxxxxxxxxxxxxxxxxxx')
+    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
 
-## TODO:
-  * finish report by and filter by options.
-  * Refactor!
-  * More Docs!
+    c = Cloudability::Organizations.new(auth_token: 'xxxxxxxxxxxxxxxxxxxx')
+    c.invite_user(email: 'colby@cloudability.com', name: 'Colby Aley')
+    c.roles
+    c.invitations
 
+## TODO:
+  * More tests!
+  * More endpoints!
+  * More awesomeness!
 
 ## Contributing
 

data/Rakefile

@@ -1,9 +1,12 @@
 require 'bundler/gem_tasks'
-require 'rake/testtask'
 
-Rake::TestTask.new do |t|
-  t.test_files = FileList['test/lib/cloudability/test_*.rb']
-  t.verbose = true
+task :default => :spec
+desc 'run Rspec specs'
+task :spec do
+  sh 'rspec'
 end
 
-task :default => :test
+task :irb do
+  require File.expand_path('../lib/cloudability.rb', __FILE__)
+  sh 'irb -r ./lib/cloudability.rb'
+end

data/cloudability.gemspec

@@ -6,16 +6,21 @@ require 'cloudability/version'
 Gem::Specification.new do |gem|
   gem.name          = "cloudability"
   gem.version       = Cloudability::VERSION
-  gem.authors       = ["Aaron Bento"]
-  gem.email         = ["abento+github@gmail.com"]
+  gem.licenses      = ['MIT']
+  gem.authors       = ["Colby Aley", "Aaron Bento"]
+  gem.email         = ["colby@cloudability.com", "abento+github@gmail.com"]
   gem.description   = %q{Ruby wrapper for the Cloudability API}
-  gem.summary       = %q{Ruby wrapper for the Cloudability API using httparty}
-  gem.homepage      = ""
+  gem.summary       = %q{Ruby wrapper for the Cloudability API built with HTTParty}
+  gem.homepage      = "https://github.com/colbyaley/cloudability"
 
   gem.files         = `git ls-files`.split($/)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
-  gem.add_dependency('httparty')
-  gem.add_dependency('mash')
+  gem.add_dependency('httparty', "~> 0.9.0")
+  gem.add_dependency('hashie')
+
+  gem.add_development_dependency('rspec')
+  gem.add_development_dependency('fakeweb')
+  gem.add_development_dependency('rake', '~> 0.6')
 end

data/lib/cloudability.rb

@@ -1,9 +1,9 @@
-require_relative "cloudability/version"
 require 'httparty'
-require 'mash'
+require 'hashie'
 
-module Cloudability
-  Dir[File.dirname(__FILE__) + '/cloudability/*.rb'].each do |file|
-    require file
-  end
-end
+require 'cloudability/billing'
+require 'cloudability/budgets'
+require 'cloudability/credentials'
+require 'cloudability/organizations'
+
+require 'cloudability/version'

data/lib/cloudability/billing.rb

@@ -7,60 +7,59 @@ module Cloudability
     attr_accessor :auth_token
 
     def initialize(options={})
+      raise ArgumentError, "You must provide an auth token" if options[:auth_token].nil?
+
       @auth_token = options[:auth_token]
       @params=[]
     end
 
-    # Option #1 is a hash with parameter value
-    # {:param1 => "period", }
-    def report_by(options={})
-
-      # TODO :: 
-      # - by= : period, vendor, service, credential, account
-      # https://app.cloudability.com/api/0/billing_reports?auth_token=VZSaZ65u87X2p7HqgpJv&by=vendor
-      # [{"vendor_id":1,"vendor_name":"Amazon","spend":"149744.69"}]
-      @params << "&by=account"    if options == :account
-      @params << "&by=credential" if options == :credential
-      @params << "&by=period"     if options == :period
-      @params << "&by=service"    if options == :service
-      @params << "&by=vendor"     if options == :vendor
+    # 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
+        @params << "&by=account"
+      when :credential
+        @params << "&by=credential"
+      when :period
+        @params << "&by=period"
+      when :service
+        @params << "&by=service"
+      when :vendor
+        @params << "&by=vendor"
+      else
+        raise ArgumentError, "You must provide a valid dimension to report on."
+      end
 
-      billing = get_url(@params)
-      convert_to_mashes(billing)
+      billings = get_url(@params)
+      billings.map { |b| Hashie::Mash.new(b) }
     end
 
     # Find a particular period, based on its month.
     # Period must be in YY-MM-01 format with the date always 01.
     def filter_by_period(period)
-      billing = get_billing_report(period)
-      convert_to_mash(billing)
-    end
+      unless period =~ /^[0-9]{2}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$/
+        raise ArgumentError, "You must provide a valid date in the form of 'YY-MM-DD'."
+      end
 
-    private
+      @params << "&period=#{period}"
+      single_billing = get_url(@params).first
 
-    def get_billing_report(period)
-      response = self.class.get("/billing_reports?auth_token=#{@auth_token}&period=#{period}")
-      response.success? ? response : raise(response.response)
+      Hashie::Mash.new(single_billing)
     end
 
+    private
+
+    # GET a URL with HTTParty
+    #
+    # @param [Array] array of URL params to pass to HTTParty
     def get_url(params)
       joined_param = params.join
-      url = "/billing_reports?auth_token=#{@auth_token}#{joined_param}"
       response = self.class.get("/billing_reports?auth_token=#{@auth_token}#{joined_param}")
       response.success? ? response : raise(response.response)
     end
 
-    # Convert the json into a Mash.
-    def convert_to_mash(response)
-      mash = Mash.new(response.first)
-    end
-
-    # Convert the json into an Array of Mashes.
-    def convert_to_mashes(response)
-      billings =[]
-      response.each { |b| billings << Mash.new(b)}
-      return billings
-    end
-
   end
-end
+end

data/lib/cloudability/budgets.rb

@@ -7,6 +7,7 @@ module Cloudability
     attr_accessor :auth_token
 
     def initialize(options={})
+      raise ArgumentError, "You must provide an auth token" if options[:auth_token].nil?
       @auth_token = options[:auth_token]
     end
 
@@ -17,14 +18,16 @@ module Cloudability
 
     # Find a particular budget, based on its id, and return a mash.
     def find_by_id(id)
-      all_budgets = find_all
-      budget = all_budgets.select {|r| r.id == id}.first
+      find_all.select {|b| b.id == id}.first
     end
 
     # Find a particular budget, based on its subject, and return a mash.
     def find_by_subject(subject)
-      all_budgets = find_all
-      budget = all_budgets.select {|r| r.subject == subject}.first
+      unless subject.length == 14
+        raise ArgumentError, "You must provide a valid subject such as 1234-5678-9101."
+      end
+      
+      find_all.select {|b| b.subject == subject}.first
     end
 
     # Find a particular budget, based on a key, and return a mash.
@@ -34,22 +37,25 @@ module Cloudability
         budget = find_by_id(options[:value])
       when :subject
         budget = find_by_subject(options[:value])
+      else
+        raise ArgumentError, "You must provide a valid key."
       end
     end
 
     private
 
     def get_budgets
-      response = self.class.get("/budgets/index?auth_token=#{self.auth_token}")
+      response = self.class.get("/budgets/index?auth_token=#{@auth_token}")
       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)
-      budgets =[]
-      response.each { |b| budgets << Mash.new(b)}
-      return budgets
+      response.map { |budget| Hashie::Mash.new(budget) }
     end
 
   end
-end
+end

data/lib/cloudability/credentials.rb

@@ -7,6 +7,7 @@ module Cloudability
     attr_accessor :auth_token
 
     def initialize(options={})
+      raise ArgumentError, "You must provide an auth token" if options[:auth_token].nil?
       @auth_token = options[:auth_token]
     end
 
@@ -17,15 +18,16 @@ module Cloudability
     private
 
     def get_credentials
-      response = self.class.get("/credentials/index?auth_token=#{self.auth_token}")
+      response = self.class.get("/credentials/index?auth_token=#{@auth_token}")
       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)
-      credentials = []
-      mashes = response.each { |c| credentials << Mash.new(c) }
-      return credentials
+      response.map { |credential| Hashie::Mash.new(credential) }
     end
 
   end

data/lib/cloudability/organizations.rb

@@ -0,0 +1,71 @@
+module Cloudability
+  class Organizations
+    include HTTParty
+    base_uri "https://app.cloudability.com/api/1"
+    format :json
+
+    attr_accessor :auth_token
+
+    def initialize(options={})
+      raise ArgumentError, "You must provide an auth token" if options[:auth_token].nil?
+
+      @auth_token = options[:auth_token]
+    end
+
+    def 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
+
+    def roles
+      response = get_url("/organizations/roles?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
+
+    # 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