cloudability 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.DS_Store

data/Gemfile

@@ -0,0 +1,12 @@
+source :rubygems
+gem 'httparty'
+gem 'mash'
+
+group :test do
+  gem 'turn'
+  gem 'rake'
+
+  gem 'shoulda'
+  gem 'fakeweb'
+  gem 'jnunemaker-matchy'
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Aaron Bento
+
+MIT License
+
+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 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

@@ -0,0 +1,60 @@
+# Cloudability
+
+Ruby wrapper for the Cloudability API using httparty.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'cloudability'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cloudability
+
+## Usage
+
+  Covers endpoints:
+  * credentials
+  * budgets
+  * and partial billing_reports
+  
+
+### Credential Endpoint:
+  Caputure an array containing all your Cloud Accounts 
+
+    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
+
+
+## TODO:
+  * finish report by and filter by options.
+  * Refactor!
+  * More Docs!
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,9 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.test_files = FileList['test/lib/cloudability/test_*.rb']
+  t.verbose = true
+end
+
+task :default => :test

data/cloudability.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+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.description   = %q{Ruby wrapper for the Cloudability API}
+  gem.summary       = %q{Ruby wrapper for the Cloudability API using httparty}
+  gem.homepage      = ""
+
+  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')
+end

data/lib/cloudability.rb

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

data/lib/cloudability/billing.rb

@@ -0,0 +1,66 @@
+module Cloudability
+  class Billing
+    include HTTParty
+    base_uri "https://app.cloudability.com/api/0"
+    format :json
+
+    attr_accessor :auth_token
+
+    def initialize(options={})
+      @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
+
+      billing = get_url(@params)
+      convert_to_mashes(billing)
+    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
+
+    private
+
+    def get_billing_report(period)
+      response = self.class.get("/billing_reports?auth_token=#{@auth_token}&period=#{period}")
+      response.success? ? response : raise(response.response)
+    end
+
+    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

data/lib/cloudability/budgets.rb

@@ -0,0 +1,55 @@
+module Cloudability
+  class Budgets
+    include HTTParty
+    base_uri "https://app.cloudability.com/api/1"
+    format :json
+
+    attr_accessor :auth_token
+
+    def initialize(options={})
+      @auth_token = options[:auth_token]
+    end
+
+    # Return all the budgets for the current account, and return as mash's.
+    def find_all
+      convert_to_mashes(get_budgets)
+    end
+
+    # 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
+    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
+    end
+
+    # Find a particular budget, based on a key, and return a mash.
+    def find_by_key(options={})
+      case options[:key]
+      when :id
+        budget = find_by_id(options[:value])
+      when :subject
+        budget = find_by_subject(options[:value])
+      end
+    end
+
+    private
+
+    def get_budgets
+      response = self.class.get("/budgets/index?auth_token=#{self.auth_token}")
+      response.success? ? response : raise(response.response)
+    end
+
+    # Convert the json into an Array of Mashes.
+    def convert_to_mashes(response)
+      budgets =[]
+      response.each { |b| budgets << Mash.new(b)}
+      return budgets
+    end
+
+  end
+end

data/lib/cloudability/credentials.rb

@@ -0,0 +1,32 @@
+module Cloudability
+  class Credentials
+    include HTTParty
+    base_uri "https://app.cloudability.com/api/0"
+    format :json
+
+    attr_accessor :auth_token
+
+    def initialize(options={})
+      @auth_token = options[:auth_token]
+    end
+
+    def find_all
+      convert_to_mashes(get_credentials)
+    end
+
+    private
+
+    def get_credentials
+      response = self.class.get("/credentials/index?auth_token=#{self.auth_token}")
+      response.success? ? response : raise(response.response)
+    end
+
+    # Convert the json into an Array of Mashes.
+    def convert_to_mashes(response)
+      credentials = []
+      mashes = response.each { |c| credentials << Mash.new(c) }
+      return credentials
+    end
+
+  end
+end

data/lib/cloudability/time_helper.rb

@@ -0,0 +1,26 @@
+require 'date'
+require 'mash'
+
+# Cloudability requires time periods formatted in YYYY-MM-01 The date must always be 1.
+# This provides a set of helpers to always return the correct period format.
+
+class TimeHelper
+
+  def last_three_months
+    dt = DateTime.now
+
+    current_month = dt.strftime("%Y-%m-01")
+    last_month    = (dt << 1).strftime("%Y-%m-01")
+    three_month   = (dt << 2).strftime("%Y-%m-01")
+   
+    hash = { :current => current_month, :last => last_month, :three => three_month }    
+    mash = Mash.new(hash)
+    return mash
+  end
+
+  # Returns the current month
+  def current_month
+    DateTime.now.strftime("%Y-%m-01")
+  end
+
+end

data/lib/cloudability/version.rb

@@ -0,0 +1,3 @@
+module Cloudability
+  VERSION = "0.0.1"
+end

data/test/fixtures/billing_report_by-vendor.json

@@ -0,0 +1 @@
+[{"vendor_id":1,"vendor_name":"Amazon","spend":"100000.99"}]

data/test/fixtures/billing_report_period.json

@@ -0,0 +1 @@
+[{"period":"2012-11-01","spend":"4987.99"}]

data/test/fixtures/billing_report_year.json

@@ -0,0 +1,54 @@
+[
+    {
+        "period": "2011-11-01",
+        "spend": "4463.67"
+    },
+    {
+        "period": "2011-12-01",
+        "spend": "5207.81"
+    },
+    {
+        "period": "2012-01-01",
+        "spend": "6398.46"
+    },
+    {
+        "period": "2012-02-01",
+        "spend": "7645.38"
+    },
+    {
+        "period": "2012-03-01",
+        "spend": "10005.89"
+    },
+    {
+        "period": "2012-04-01",
+        "spend": "12363.48"
+    },
+    {
+        "period": "2012-05-01",
+        "spend": "13752.46"
+    },
+    {
+        "period": "2012-06-01",
+        "spend": "12618.84"
+    },
+    {
+        "period": "2012-07-01",
+        "spend": "13739.12"
+    },
+    {
+        "period": "2012-08-01",
+        "spend": "13461.66"
+    },
+    {
+        "period": "2012-09-01",
+        "spend": "12741.14"
+    },
+    {
+        "period": "2012-10-01",
+        "spend": "12729.93"
+    },
+    {
+        "period": "2012-11-01",
+        "spend": "4987.99"
+    }
+]

data/test/fixtures/budgets.json

@@ -0,0 +1,34 @@
+[
+    {
+        "predicted_monthly_spend": {
+            "cents": 1000000,
+            "currency": {
+                "id": 146,
+                "key": "usd",
+                "priority": 1,
+                "iso_code": "USD"
+            }
+        },
+        "subject": "1234-5678-90A",
+        "type": "Account",
+        "id": 1234,
+        "is_active": true,
+        "threshold": "100000.0"
+    },
+    {
+        "predicted_monthly_spend": {
+            "cents": 10000000,
+            "currency": {
+                "id": 146,
+                "key": "usd",
+                "priority": 1,
+                "iso_code": "USD"
+            }
+        },
+        "subject": "user@example.com",
+        "type": "User",
+        "id": 9999,
+        "is_active": true,
+        "threshold": "10000.0"
+    }
+]

data/test/fixtures/credentials.json

@@ -0,0 +1,28 @@
+[
+    {
+        "has_auth": true,
+        "has_estimate": false,
+        "is_duplicate": false,
+        "vendor_key": "Amazon",
+        "id": 10001,
+        "vendor_id": 1,
+        "created_at": "2011-11-01T00:00:00Z",
+        "updated_at": "2012-11-01T00:00:00Z",
+        "nickname": "Amazon Example",
+        "state": "verified",
+        "account_identifier": "1234-5678-90A",
+        "account_created_at": "2011-11-01T00:00:00Z"
+    },
+    {
+        "has_auth": false,
+        "has_estimate": false,
+        "is_duplicate": false,
+        "vendor_key": "Cloudability",
+        "id": 10001,
+        "vendor_id": 122,
+        "created_at": "2012-11-01T00:00:00Z",
+        "updated_at": "2012-11-01T00:00:00Z",
+        "nickname": "Cloudability",
+        "state": "invisible"
+    }
+]

data/test/helper.rb

@@ -0,0 +1,22 @@
+require 'test/unit'
+require 'turn/autorun'
+require 'shoulda'
+require 'fakeweb'
+require 'matchy'
+
+require_relative '../lib/cloudability'
+
+FakeWeb.allow_net_connect = false
+
+def fixture_file(filename)
+  return '' if filename == ''
+  file_path = File.expand_path(File.dirname(__FILE__) + '/fixtures/' + filename)
+  File.read(file_path)
+end
+
+def stub_get(url, filename, status=nil)
+  options = {:body => fixture_file(filename)}
+  options.merge!({:status => status}) unless status.nil?
+  
+  FakeWeb.register_uri(:get, url, options)
+end

data/test/lib/cloudability/test_billing.rb

@@ -0,0 +1,55 @@
+require_relative '../../helper'
+
+class TestCloudability < Test::Unit::TestCase
+  context "Billing :: Hitting the Cloudability Billing API" do
+    setup do
+      @auth_token = 'xxxxxxxxxxxxxxxxxxxx'
+      @report = Cloudability::Billing.new(:auth_token => @auth_token)
+
+      # The billing API endpoint
+      @billing_uri = "https://app.cloudability.com/api/0/billing_reports?auth_token=#{@auth_token}"
+      @default_fixture = "billing_report_period.json"
+    end
+
+    # Filter by TODO :: 
+    # - <filter>= : vendor, service, credential, account
+    # - combine filters
+    should "return a single period Mash containing spending" do
+      period = "2012-11-01"
+      uri = "#{@billing_uri}&period=#{period}"
+
+      stub_get uri, @default_fixture
+      single_period = @report.filter_by_period(period)
+      single_period.period.should == period
+      single_period.spend.should == "4987.99"
+    end
+
+    # Report by TODO :: 
+    # - by= : service, credential, account
+    # - combine filters
+
+    should "report by period" do
+      uri = "#{@billing_uri}&by=period"
+      stub_get uri, "billing_report_year.json"
+      
+      billing_report = @report.report_by(:period)
+      
+      billing_report.count.should == 13
+      billing_report.first.period.should == "2011-11-01"
+      billing_report.last.period.should == "2012-11-01"
+      billing_report.last.spend.should == "4987.99"
+    end
+
+    should "report by vendor" do
+      uri = "#{@billing_uri}&by=vendor"
+      stub_get uri, "billing_report_by-vendor.json"
+      
+      billing_report = @report.report_by(:vendor)
+      
+      billing_report.count.should == 1
+      billing_report.first.vendor_name.should == "Amazon"
+      billing_report.last.spend.should == "100000.99"
+    end
+
+  end
+end

data/test/lib/cloudability/test_budgets.rb

@@ -0,0 +1,44 @@
+require_relative '../../helper'
+
+class TestCloudability < Test::Unit::TestCase
+  context "Budgets :: Hitting the Cloudability Budgets API" do
+    setup do
+      @auth_token = 'xxxxxxxxxxxxxxxxxxxx'
+      @budgets = Cloudability::Budgets.new(:auth_token => @auth_token)
+
+      # The budget API endpoint
+      @default_uri = "https://app.cloudability.com/api/1/budgets/index?auth_token=#{@auth_token}"
+      @default_fixture = "budgets.json"
+    end
+
+    should "return all budgets in an Array of Mashes" do
+      stub_get @default_uri, @default_fixture
+      all_budgets = @budgets.find_all
+      all_budgets.class.should ==  Array
+      all_budgets.each { |b| b.class.should ==  Mash }
+    end
+
+    should "return a single budget Mash when calling find with an id" do
+      stub_get @default_uri, @default_fixture
+      single_budget = @budgets.find_by_id(1234)
+      single_budget.subject.should == "1234-5678-90A"
+    end
+
+    should "return a single budget Mash when calling find with a subject" do
+      stub_get @default_uri, @default_fixture
+      single_budget = @budgets.find_by_subject("1234-5678-90A")
+      single_budget.id.should == 1234
+    end
+
+    should "return a single budget Mash when calling find with a key" do
+      stub_get @default_uri, @default_fixture
+
+      single_budget = @budgets.find_by_key({ :key => :id, :value => 1234 })
+      single_budget.subject.should == "1234-5678-90A"
+
+      single_budget = @budgets.find_by_key({ :key => :subject, :value => "1234-5678-90A" })
+      single_budget.id.should == 1234
+    end
+
+  end
+end

data/test/lib/cloudability/test_credentials.rb

@@ -0,0 +1,21 @@
+require_relative '../../helper'
+
+class TestCloudability < Test::Unit::TestCase
+  context "Credentials :: Hitting the Cloudability Credentials API" do
+    setup do
+      @auth_token = 'xxxxxxxxxxxxxxxxxxxx'
+      @credentials = Cloudability::Credentials.new(:auth_token => @auth_token)
+
+      # The budget API endpoint
+      @default_uri = "https://app.cloudability.com/api/0/credentials/index?auth_token=#{@auth_token}"
+      @default_fixture = "credentials.json"
+    end
+
+    should "return all credentials in an Array of Mashes" do
+      stub_get @default_uri, @default_fixture
+      all_credentials = @credentials.find_all
+      all_credentials.class.should ==  Array
+      all_credentials.each { |c| c.class.should ==  Mash }
+    end
+  end
+end

data/test/lib/cloudability/test_time_helper.rb

@@ -0,0 +1,24 @@
+require_relative '../../helper'
+
+class TestCloudability < Test::Unit::TestCase
+  context "Time Helper :: When using time_helper, it" do
+    setup do
+      @mock_dt = DateTime.parse("2012-11-02T00:00:00+00:00")
+      @real_dt = DateTime.now
+      @timehelper = TimeHelper.new
+    end
+
+    should "return the current month in YYYY-MM-01" do
+       currrent_month = DateTime.now.strftime("%Y-%m-01")
+       @timehelper.current_month.should == currrent_month
+    end
+
+    should "return a Mash with the last three months in YYYY-MM-01" do
+      months = @timehelper.last_three_months
+      months.current.should == "2012-11-01"
+      months.last.should    == "2012-10-01"
+      months.three.should   == "2012-09-01"
+    end
+
+  end
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: cloudability
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Aaron Bento
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mash
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ruby wrapper for the Cloudability API
+email:
+- abento+github@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- cloudability.gemspec
+- lib/cloudability.rb
+- lib/cloudability/billing.rb
+- lib/cloudability/budgets.rb
+- lib/cloudability/credentials.rb
+- lib/cloudability/time_helper.rb
+- lib/cloudability/version.rb
+- test/fixtures/billing_report_by-vendor.json
+- test/fixtures/billing_report_period.json
+- test/fixtures/billing_report_year.json
+- test/fixtures/budgets.json
+- test/fixtures/credentials.json
+- test/helper.rb
+- test/lib/cloudability/test_billing.rb
+- test/lib/cloudability/test_budgets.rb
+- test/lib/cloudability/test_credentials.rb
+- test/lib/cloudability/test_time_helper.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Ruby wrapper for the Cloudability API using httparty
+test_files:
+- test/fixtures/billing_report_by-vendor.json
+- test/fixtures/billing_report_period.json
+- test/fixtures/billing_report_year.json
+- test/fixtures/budgets.json
+- test/fixtures/credentials.json
+- test/helper.rb
+- test/lib/cloudability/test_billing.rb
+- test/lib/cloudability/test_budgets.rb
+- test/lib/cloudability/test_credentials.rb
+- test/lib/cloudability/test_time_helper.rb