vault-usage-client 0.0.11 → 0.0.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 68c67490431226bad7e3226be45499e255db555e
-  data.tar.gz: acad611c2b6b788c30113d0df48ed4d8979c56fb
+  metadata.gz: 396f74ea5ff90f39ec688dba59339a3eb7abcd59
+  data.tar.gz: b102e37d9f160b8ea762837bbbc3ff62ee7fd5d3
 SHA512:
-  metadata.gz: d65b4dc26dc5ec6155be8714a04dbb2dba125d4ea1b929dfd79422448215ad0376f487b37e0409c4146eecffc82adb163bb71c0d95529971bc1730ea87aabbba
-  data.tar.gz: 378ebbab8db4dc0e4a27bd7d75a1dd679b5b54bccfb333929ec032cfcbfd7e3a9367efb0c59f8a8a21c81d42a641838a99198c06dc7bfb3728ea21f44fc875f2
+  metadata.gz: 72451c5898b32134424a27efdc97b40213866c6dee9cf80fdbc88a4d5071dcfc75dd6748e4697b72c92cf11f663c57e1788719d3c316ff5c8a222107b6a85805
+  data.tar.gz: bd44043d3dd67c23c7fef8f0319fc818679fb8504d4a271cfc17330de548b2be1321d34eab89c973930c52fa28995b8241e95f4980c14614c62b858dca9c0d25

data/Gemfile.lock

@@ -1,10 +1,10 @@
 PATH
   remote: .
   specs:
-    vault-usage-client (0.0.11)
-      colorize (~> 0.7.3)
-      excon (~> 0.39.5)
-      multi_json (~> 1.10.1)
+    vault-usage-client (0.0.12)
+      colorize
+      excon
+      multi_json
 
 GEM
   remote: https://rubygems.org/
@@ -82,3 +82,6 @@ DEPENDENCIES
   vault-test-tools
   vault-usage-client!
   yard
+
+BUNDLED WITH
+   1.10.6

data/README.md

@@ -118,7 +118,7 @@ The `events` result is an `Array` of objects matching this format:
   detail: {<key1>: <value1>,
            <key2>: <value2>,
            ...}},
-  ...]}
+  ...]
 ```
 
 In some cases it can be useful to exclude event data for certain
@@ -134,6 +134,28 @@ events = client.usage_for_user(user_hid, start_time, stop_time,
 
 You can pass one or more product names to exclude.
 
+#### Retrieving a single usage event
+
+A usage event can be retrieved with the client:
+
+```
+event_id = '3b1086ea-07df-4324-a35f-b28a1474bd9b'
+event = client.usage_for_event(event_id)
+```
+
+The `event` result is an object matching this format:
+
+```ruby
+{id: '<event-uuid>',
+  product: '<name>',
+  consumer: '<consumer-hid>',
+  start_time: <Time>,
+  stop_time: <Time>,
+  detail: {<key1>: <value1>,
+           <key2>: <value2>,
+           ...}}
+```
+
 ### App ownership events
 
 App ownership events represent ownership of an app, for a period of

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

@@ -152,6 +152,10 @@ module Vault::Usage
     # @param exclude [Array] Optionally, a list of product names, such as
     #   `['platform:dyno:physical', 'addon:memcache:100mb']`, to be excluded
     #   from usage data.
+    # @param callback_url [String] The URL vault-usage will callback after generating
+    # usage events JSON
+    # @param snapshot [Boolean] Whether or not to return only events that were open
+    # at the start_time
     # @raise [InvalidTimeError] Raised if a non-UTC start or stop time is
     #   provided.
     # @raise [Excon::Errors::HTTPStatusError] Raised if the server returns an
@@ -170,7 +174,7 @@ module Vault::Usage
     #                ...}},
     #       ...]}
     #   ```
-    def usage_for_user(user_hid, start_time, stop_time, exclude=nil, callback_url = nil)
+    def usage_for_user(user_hid, start_time, stop_time, exclude=nil, callback_url=nil, snapshot=false)
       unless start_time.zone.eql?('UTC')
         raise InvalidTimeError.new('Start time must be in UTC.')
       end
@@ -178,8 +182,9 @@ module Vault::Usage
         raise InvalidTimeError.new('Stop time must be in UTC.')
       end
       path = "/users/#{user_hid}/usage/#{iso_format(start_time)}/" +
-             "#{iso_format(stop_time)}"
+                   "#{iso_format(stop_time)}"
       query = {}
+      query[:snapshot] = true if snapshot
       unless exclude.nil? || exclude.empty?
         query[:exclude] = exclude.join(',')
       end

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.11'
+      VERSION = '0.0.12'
     end
   end
 end

data/test/client_test.rb

@@ -278,6 +278,16 @@ class ClientTest < Vault::TestCase
       @client.usage_for_user(@user_hid, @start_time, @stop_time, nil,'http://example.com'))
   end
 
+  def test_usage_for_user_with_callback_url_and_snapshot
+    Excon.stub(method: :get) do |request|
+      assert_equal({callback_url: 'http://example.com', snapshot: true}, request[:query])
+      Excon.stubs.pop
+      {status: 200, body: MultiJson.dump({job_id: 'DEADBEEF'})}
+    end
+    assert_equal('DEADBEEF',
+      @client.usage_for_user(@user_hid, @start_time, @stop_time, nil,'http://example.com', true))
+  end
+
   # Client.usage_for_user comma-separates product names, when many are
   # provided in the exclusion list, and passes them to the server using a
   # single query argument.

data/vault-usage-client.gemspec

@@ -17,7 +17,7 @@ Gem::Specification.new do |gem|
   gem.require_paths = ['lib']
   gem.executables   = ['vault-usage']
 
-  gem.add_dependency 'excon', '~> 0.39.5'
-  gem.add_dependency 'multi_json', '~> 1.10.1'
-  gem.add_dependency 'colorize', '~> 0.7.3'
+  gem.add_dependency 'excon'
+  gem.add_dependency 'multi_json'
+  gem.add_dependency 'colorize'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vault-usage-client
 version: !ruby/object:Gem::Version
-  version: 0.0.11
+  version: 0.0.12
 platform: ruby
 authors:
 - Chris Continanza
@@ -9,50 +9,50 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-26 00:00:00.000000000 Z
+date: 2016-03-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: excon
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.39.5
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.39.5
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: multi_json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.10.1
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.10.1
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: colorize
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.7.3
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.7.3
+        version: '0'
 description: Client for Vault::Usage
 email:
 - csquared@heroku.com