vault-usage-client 0.0.8 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5537f1ed6faba6000f84cf0e909715e907713f3d
-  data.tar.gz: 1b99454688ff02d2bd9fbb75b220283a7d4de29d
+  metadata.gz: 286fda12d23933d982e5f9d1f2c77171f161fe23
+  data.tar.gz: 4d37cca0d12010a7aa6844f7585959eaeb9c336b
 SHA512:
-  metadata.gz: f95383bfb53f250db7dbe4a1e09546f103a9f8392bb3d6c1a6ecfcaa2f8e448afdf2fd6e5573014a579c93e2a7ffba1014f69e7e0c5e50e22548df1716b012b2
-  data.tar.gz: 12db53a91b8b6e9bd3c022f5c0b9905f38f5306ef6ed5d6896daa1c53479663a9789f3c298c96326cfc76778498c17d84eda8608c9f34b7c16734ec693386834
+  metadata.gz: 8b39d012a2896e9ad4cb980b495e057ec66260902f02a40d050e056079fe3ba3daf37fc86baad3618e6218a07487d74d541b72cc62ab98ae5b9a3bc465c7d59b
+  data.tar.gz: 82dc3d786ad37fcfa3f7d03c32c588a885ad122ddaafd519a8a3eaa61d4ad05f76ad5f1be8d9052a0bdb7e67da0af369db35082a09fd920d7a42e71a64f71c9f

data/Gemfile

@@ -12,3 +12,5 @@ group :test do
   gem 'scrolls'
   gem 'vault-test-tools'
 end
+
+gem 'pry', group: [:development, :test]

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    vault-usage-client (0.0.8)
+    vault-usage-client (0.0.9)
       colorize
       excon
       multi_json
@@ -14,8 +14,8 @@ GEM
     celluloid (0.15.2)
       timers (~> 1.1.0)
     coderay (1.1.0)
-    colorize (0.6.0)
-    excon (0.27.1)
+    colorize (0.7.3)
+    excon (0.39.5)
     ffi (1.9.3)
     formatador (0.2.5)
     guard (2.6.1)
@@ -37,7 +37,7 @@ GEM
     method_source (0.8.2)
     mini_portile (0.6.0)
     minitest (4.7.5)
-    multi_json (1.8.1)
+    multi_json (1.10.1)
     nokogiri (1.6.2.1)
       mini_portile (= 0.6.0)
     parslet (1.6.1)
@@ -75,6 +75,7 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  pry
   rake
   rr
   scrolls

data/bin/console

@@ -0,0 +1,26 @@
+#!/usr/bin/env ruby
+
+### Bundler ##
+require 'bundler/setup'
+
+Bundler.require(:development)
+
+APP_ROOT=File.expand_path(File.dirname(__FILE__)) + "/.."
+
+require File.join(APP_ROOT,'/lib/vault-usage-client.rb')
+include Vault::Usage
+
+# add ability to reload console
+def reload!
+  reload_msg = '# Reloading the console...'
+  puts CodeRay.scan(reload_msg, :ruby).term
+  Pry.save_history
+  exec(File.expand_path(__FILE__), 'bin/console')
+end
+
+system('clear')
+welcome = <<eos
+# Welcome to Vault Usage Client Interactive Console
+eos
+puts CodeRay.scan(welcome, :ruby).term
+Pry.start

data/lib/vault-usage-client/client.rb

@@ -170,6 +170,42 @@ module Vault::Usage
       end
     end
 
+    # Get the usage events for a product specific to a user.
+    #
+    # @param user_hid [String] The user HID, such as `user1234@heroku.com`, to
+    #   fetch usage data for.
+    # @param product_name [String] The product name such as `account:credit:lumpsum`, to
+    #   fetch usage data for.
+    # @raise [Excon::Errors::HTTPStatusError] Raised if the server returns an
+    #   unsuccessful HTTP status code.
+    # @return [Array] A list of usage events for the specified user, matching
+    #   the following format:
+    #
+    #   ```
+    #     [{id: '<event-uuid>',
+    #       product: '<name>',
+    #       consumer: '<heroku-id>',
+    #       start_time: <Time>,
+    #       stop_time: <Time>,
+    #       detail: {<key1>: <value1>,
+    #                <key2>: <value2>,
+    #                ...}},
+    #       ...]}
+    #   ```
+    def usage_for_user_by_product(user_hid, product_name)
+      path = "/users/#{user_hid}/usage/product/#{product_name}"
+      connection = Excon.new(@url)
+      response = connection.get(path: path, expects: [200])
+      payload = MultiJson.load(response.body, {symbolize_keys: true})
+      return payload[:job_id] if payload[:job_id]
+      events = payload[:events]
+      events.each do |event|
+        event.each do |key, value|
+          event[key] = parse_date(value) if date?(value)
+        end
+      end
+    end
+
     # Get the open dyno usage events for the specified app
     #
     # @param app_hid [String] The app HID, such as `app1234@heroku.com`, to

data/lib/vault-usage-client/version.rb

@@ -2,7 +2,7 @@ module Vault
   module Usage
     class Client
       # The `Vault::Usage::Client` gem version.
-      VERSION = '0.0.8'
+      VERSION = '0.0.9'
     end
   end
 end

data/test/client_test.rb

@@ -48,7 +48,7 @@ class ClientTest < Vault::TestCase
       assert_equal('Basic dXNlcm5hbWU6c2VjcmV0',
                    request[:headers]['Authorization'])
       assert_equal('vault-usage.herokuapp.com', request[:host])
-      assert_equal('443', request[:port])
+      assert_equal(443, request[:port])
       assert_equal("/products/#{@product_name}/usage/#{@app_hid}" +
                    "/events/#{@event_id}/open/#{iso_format(@start_time)}",
                    request[:path])
@@ -106,7 +106,7 @@ class ClientTest < Vault::TestCase
       assert_equal('Basic dXNlcm5hbWU6c2VjcmV0',
                    request[:headers]['Authorization'])
       assert_equal('vault-usage.herokuapp.com', request[:host])
-      assert_equal('443', request[:port])
+      assert_equal(443, request[:port])
       assert_equal("/products/#{@product_name}/usage/#{@app_hid}" +
                    "/events/#{@event_id}/close/#{iso_format(@stop_time)}",
                    request[:path])
@@ -147,7 +147,7 @@ class ClientTest < Vault::TestCase
       assert_equal('Basic dXNlcm5hbWU6c2VjcmV0',
                    request[:headers]['Authorization'])
       assert_equal('vault-usage.herokuapp.com', request[:host])
-      assert_equal('443', request[:port])
+      assert_equal(443, request[:port])
       assert_equal("/products/#{@product_name}/usage/#{@app_hid}" +
                    "/events/#{@event_id}/open/#{iso_format(@start_time)}" +
                    "/close/#{iso_format(@stop_time)}",
@@ -221,7 +221,7 @@ class ClientTest < Vault::TestCase
       assert_equal('Basic dXNlcm5hbWU6c2VjcmV0',
                    request[:headers]['Authorization'])
       assert_equal('vault-usage.herokuapp.com', request[:host])
-      assert_equal('443', request[:port])
+      assert_equal(443, request[:port])
       assert_equal("/users/#{@user_hid}/usage/#{iso_format(@start_time)}/" +
                    "#{iso_format(@stop_time)}",
                    request[:path])
@@ -344,7 +344,7 @@ class ClientTest < Vault::TestCase
       assert_equal('Basic dXNlcm5hbWU6c2VjcmV0',
                    request[:headers]['Authorization'])
       assert_equal('vault-usage.herokuapp.com', request[:host])
-      assert_equal('443', request[:port])
+      assert_equal(443, request[:port])
       assert_equal("/users/#{@user_hid}/apps/#{@app_hid}/open/#{@event_id}" +
                    "/#{iso_format(@start_time)}",
                    request[:path])
@@ -389,7 +389,7 @@ class ClientTest < Vault::TestCase
       assert_equal('Basic dXNlcm5hbWU6c2VjcmV0',
                    request[:headers]['Authorization'])
       assert_equal('vault-usage.herokuapp.com', request[:host])
-      assert_equal('443', request[:port])
+      assert_equal(443, request[:port])
       assert_equal("/users/#{@user_hid}/apps/#{@app_hid}/close/#{@event_id}" +
                    "/#{iso_format(@stop_time)}",
                    request[:path])
@@ -433,11 +433,27 @@ class ClientTest < Vault::TestCase
       assert_equal('Basic dXNlcm5hbWU6c2VjcmV0',
                    request[:headers]['Authorization'])
       assert_equal('vault-usage.herokuapp.com', request[:host])
-      assert_equal('443', request[:port])
+      assert_equal(443, request[:port])
       assert_equal("/apps/#{@app_hid}/ps/open", request[:path])
       Excon.stubs.pop
       {status: 200, body: MultiJson.dump({events: []})}
     end
     assert_equal([], @client.open_dynos_for_app(@app_hid))
   end
+
+  # Client.usage_for_user_by_product  makes a GET request to the Vault::Usage HTTP API,
+  # passing the supplied credentials using HTTP basic auth, to retrieve the
+  # usage events specific to a product
+  def test_usage_for_user_by_product
+    Excon.stub(method: :get) do |request|
+      assert_equal('Basic dXNlcm5hbWU6c2VjcmV0',
+                   request[:headers]['Authorization'])
+      assert_equal('vault-usage.herokuapp.com', request[:host])
+      assert_equal(443, request[:port])
+      assert_equal("/users/#{@user_hid}/usage/product/#{@product_name}", request[:path])
+      Excon.stubs.pop
+      {status: 200, body: MultiJson.dump({events: []})}
+    end
+    assert_equal([], @client.usage_for_user_by_product(@user_hid, @product_name))
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vault-usage-client
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.9
 platform: ruby
 authors:
 - Chris Continanza
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-27 00:00:00.000000000 Z
+date: 2014-10-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: excon
@@ -63,7 +63,6 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
-- ".ruby-gemset"
 - ".ruby-version"
 - ".travis.yml"
 - ".yardopts"
@@ -71,6 +70,7 @@ files:
 - Gemfile.lock
 - README.md
 - Rakefile
+- bin/console
 - bin/vault-usage
 - lib/vault-usage-client.rb
 - lib/vault-usage-client/client.rb

data/.ruby-gemset

@@ -1 +0,0 @@
-vault-usage-client