vault-usage-client 0.0.6 → 0.0.7

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 102e34a7cb1dd30db607612394f6b8b8d3b94af9
+  data.tar.gz: a901605e7da73791d57631ea4a726d2d051d8f42
+SHA512:
+  metadata.gz: 3adb16ddbb8a0883730202843aa845f50a1f0fde8d274cf60ce1cb11025acf5b34fb29952ab33faf11fc25965626dfd0389a43bba27ffe502bb6aba2af3ab6ff
+  data.tar.gz: 2708bea990ecff179dbefe9542092ff28927610bac75e28778f2e28c7526b3995bdfe724fadba6f29de492c4efea79e904ca527db5d0984440bb936d20273f0e

data/Gemfile

@@ -8,5 +8,5 @@ end
 
 group :test do
   gem 'rr'
-  gem 'vault-test-tools', '~> 0.2.2', :git => 'https://github.com/heroku/vault-test-tools.git'
+  gem 'vault-test-tools'
 end

data/Gemfile.lock

@@ -1,17 +1,3 @@
-GIT
-  remote: https://github.com/heroku/vault-test-tools.git
-  revision: 14b52d0aad51aeefa58b7fc00dde63d5e578cbe8
-  specs:
-    vault-test-tools (0.2.4)
-      minitest
-      nokogiri
-      rack-perftools_profiler
-      rack-test
-      rdoc
-      redcarpet
-      turn
-      yard
-
 PATH
   remote: .
   specs:
@@ -24,29 +10,41 @@ GEM
   remote: https://rubygems.org/
   specs:
     ansi (1.4.3)
-    colorize (0.5.8)
-    excon (0.25.3)
-    json (1.7.7)
-    minitest (4.7.1)
-    multi_json (1.7.9)
-    nokogiri (1.5.9)
+    colorize (0.6.0)
+    excon (0.27.1)
+    json (1.8.0)
+    mini_portile (0.5.1)
+    minitest (4.7.4)
+    multi_json (1.8.1)
+    nokogiri (1.6.0)
+      mini_portile (~> 0.5.0)
     open4 (1.3.0)
-    perftools.rb (2.0.0)
+    perftools.rb (2.0.1)
     rack (1.5.2)
-    rack-perftools_profiler (0.6.0)
+    rack-perftools_profiler (0.6.1)
       open4 (~> 1.0)
-      perftools.rb (~> 2.0.0)
+      perftools.rb (~> 2.0.1)
       rack (~> 1.0)
     rack-test (0.6.2)
       rack (>= 1.0)
-    rake (10.0.4)
+    rake (10.1.0)
     rdoc (4.0.1)
       json (~> 1.4)
-    redcarpet (2.2.2)
-    rr (1.0.5)
+    redcarpet (3.0.0)
+    rr (1.1.2)
     turn (0.9.6)
       ansi
-    yard (0.8.6.1)
+    vault-test-tools (0.3.4)
+      minitest (= 4.7.4)
+      nokogiri
+      rack-perftools_profiler
+      rack-test
+      rdoc
+      redcarpet
+      rr
+      turn
+      yard
+    yard (0.8.7.2)
 
 PLATFORMS
   ruby
@@ -54,5 +52,5 @@ PLATFORMS
 DEPENDENCIES
   rake
   rr
-  vault-test-tools (~> 0.2.2)!
+  vault-test-tools
   vault-usage-client!

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

@@ -74,6 +74,46 @@ module Vault::Usage
       connection.put(path: path, expects: [201])
     end
 
+    # Report that usage of a product, by a user or app, started at a
+    # particular time.
+    #
+    # @param event_id [String] A UUID that uniquely identifies the usage
+    #   event.
+    # @param product_name [String] The name of the product that was used, such
+    #   as `platform:dyno:logical` or `addon:memcache:100mb`.
+    # @param consumer_hid [String] The Heroku ID, such as `app1234@heroku.com`
+    #   or `user1234@heroku.com`, that represents the user or app that used
+    #   the specified product.
+    # @param start_time [Time] The beginning of the usage period, always in
+    #   UTC.
+    # @param stop_time [Time] The end of the usage period, always in UTC.
+    # @param detail [Hash] Optionally, additional details to store with the
+    #   event.  Keys must be of type `Symbol` and values may only be of type
+    #   `String`, `Fixnum`, `Bignum`, `Float`, `TrueClass`, `FalseClass` or
+    #   `NilClass`.
+    # @raise [InvalidTimeError] Raised if a non-UTC start time is provided.
+    # @raise [Excon::Errors::HTTPStatusError] Raised if the server returns an
+    #   unsuccessful HTTP status code.
+    def open_close_usage_event(event_id, product_name, consumer_hid,
+                               start_time, stop_time, detail=nil)
+      unless start_time.zone.eql?('UTC')
+        raise InvalidTimeError.new('Start time must be in UTC.')
+      end
+      unless stop_time.zone.eql?('UTC')
+        raise InvalidTimeError.new('Stop time must be in UTC.')
+      end
+      path = "/products/#{product_name}/usage/#{consumer_hid}" +
+             "/events/#{event_id}/open/#{iso_format(start_time)}" +
+             "/close/#{iso_format(stop_time)}"
+      unless detail.nil?
+        headers = {'Content-Type' => 'application/json'}
+        body = MultiJson.dump(detail)
+      end
+      connection = Excon.new(@url)
+      connection.put(path: path, headers: headers, body: body,
+                     expects: [201])
+    end
+
     # Get the usage events for the apps owned by the specified user during the
     # specified period.
     #

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.6'
+      VERSION = '0.0.7'
     end
   end
 end

data/test/client_test.rb

@@ -66,7 +66,8 @@ class ClientTest < Vault::TestCase
               kernel: 'us-east-1-a'}
     Excon.stub(method: :put) do |request|
       assert_equal('application/json', request[:headers]['Content-Type'])
-      assert_equal(detail, MultiJson.load(request[:body], {symbolize_keys: true}))
+      assert_equal(detail, MultiJson.load(request[:body],
+                                          {symbolize_keys: true}))
       Excon.stubs.pop
       {status: 201}
     end
@@ -138,6 +139,79 @@ class ClientTest < Vault::TestCase
     end
   end
 
+  # Client.open_close_usage_event makes a PUT request to the Vault::Usage HTTP
+  # API, passing the supplied credentials using HTTP basic auth, to report
+  # that usage of a product began at a particular time.
+  def test_open_close_usage_event
+    Excon.stub(method: :put) do |request|
+      assert_equal('Basic dXNlcm5hbWU6c2VjcmV0',
+                   request[:headers]['Authorization'])
+      assert_equal('vault-usage.herokuapp.com', request[:host])
+      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)}",
+                   request[:path])
+      Excon.stubs.pop
+      {status: 201}
+    end
+    @client.open_close_usage_event(@event_id, @product_name, @app_hid,
+                                   @start_time, @stop_time)
+  end
+
+  # Client.open_close_usage_event optionally accepts a detail hash which is
+  # sent as a JSON payload in the request body when provided.
+  def test_open_close_usage_event_with_detail
+    detail = {type: 'web',
+              description: 'bundle exec bin/web',
+              kernel: 'us-east-1-a'}
+    Excon.stub(method: :put) do |request|
+      assert_equal('application/json', request[:headers]['Content-Type'])
+      assert_equal(detail, MultiJson.load(request[:body],
+                                          {symbolize_keys: true}))
+      Excon.stubs.pop
+      {status: 201}
+    end
+    @client.open_close_usage_event(@event_id, @product_name, @app_hid,
+                                   @start_time, @stop_time, detail)
+  end
+
+  # Client.open_close_usage_event raises an InvalidTimeError if the start time
+  # is not in UTC.
+  def test_open_close_usage_event_with_non_utc_start_time
+    start_time = Time.new(2013, 1, 12, 15, 25, 0, '+09:00')
+    error = assert_raises Vault::Usage::Client::InvalidTimeError do
+      @client.open_close_usage_event(@event_id, @product_name, @app_hid,
+                                     start_time, @stop_time)
+    end
+    assert_equal('Start time must be in UTC.', error.message)
+  end
+
+  # Client.open_close_usage_event raises an InvalidTimeError if the stop time
+  # is not in UTC.
+  def test_open_close_usage_event_with_non_utc_stop_time
+    stop_time = Time.new(2013, 1, 12, 15, 25, 0, '+09:00')
+    error = assert_raises Vault::Usage::Client::InvalidTimeError do
+      @client.open_close_usage_event(@event_id, @product_name, @app_hid,
+                                     @start_time, stop_time)
+    end
+    assert_equal('Stop time must be in UTC.', error.message)
+  end
+
+  # Client.open_close_usage_event raises the appropriate
+  # Excon::Errors::HTTPStatusError if an unsuccessful HTTP status code is
+  # returned by the server.
+  def test_open_close_usage_event_with_unsuccessful_response
+    Excon.stub(method: :put) do |request|
+      Excon.stubs.pop
+      {status: 400, body: 'Bad inputs provided.'}
+    end
+    assert_raises Excon::Errors::BadRequest do
+      @client.open_close_usage_event(@event_id, @product_name, @app_hid,
+                                     @start_time, @stop_time)
+    end
+  end
+
   # Client.usage_for_user makes a GET request to the Vault::Usage HTTP API,
   # passing the supplied credentials using HTTP basic auth, to retrieve the
   # usage events for a particular user that occurred during the specified

metadata

@@ -1,8 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vault-usage-client
 version: !ruby/object:Gem::Version
-  version: 0.0.6
-  prerelease: 
+  version: 0.0.7
 platform: ruby
 authors:
 - Chris Continanza
@@ -10,54 +9,48 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-23 00:00:00.000000000 Z
+date: 2014-07-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: excon
   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: multi_json
   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: colorize
   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: Client for Vault::Usage
@@ -85,33 +78,26 @@ files:
 - vault-usage-client.gemspec
 homepage: https://github.com/heroku/vault-usage-client
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -3250898009532451176
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -3250898009532451176
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: A simple wrapper around the Vault::Usage HTTP API
 test_files: []
 has_rdoc: