librato-metrics 1.3.2 → 1.4.0

data/CHANGELOG.md

@@ -1,5 +1,8 @@
 ## Changelog
 
+### Version 1.4.0
+* Add support for snapshots
+
 ### Version 1.3.2
 * Fix queue autosubmission to fire if needed after #merge! calls
 

data/README.md

@@ -287,4 +287,4 @@ We also maintain a set of [examples of common uses](https://github.com/librato/l
 
 ## Copyright
 
-Copyright (c) 2011-2013 [Librato Inc.](http://librato.com) See LICENSE for details.
+Copyright (c) 2011-2014 [Librato Inc.](http://librato.com) See LICENSE for details.

data/lib/librato/metrics.rb

@@ -80,6 +80,7 @@ module Librato
                    :delete_metrics, :update_metric, :update_metrics,
                    :submit,
                    :sources, :get_source, :update_source,
+                   :create_snapshot, :get_snapshot,
                    # Deprecated metrics methods
                    :fetch, :list, :delete, :update
 

data/lib/librato/metrics/client.rb

@@ -387,6 +387,38 @@ module Librato
         end
       end
 
+      # Create a snapshot of an instrument
+      #
+      # @example Take a snapshot of the instrument at https://metrics-api.librato.com/v1/instruments/42 using a
+      #   duration of 3 hours and ending at now.
+      #   Librato::Metrics.snapshot(subject: {instrument: {href: "https://metrics-api.librato.com/v1/instruments/42"}},
+      #                             duration: 3.hours, end_time: Time.now)
+      #
+      # @param Hash options Params for the snapshot
+      # @options options [Hash] :subject An object representing the subject of the snapshot. For now, only instruments are supported
+      # @options options [Numeric] :duration Time interval over which to take the snapshot, defaults to 1 hour
+      # @options options [Numeric, Time] :end_time Snapshot the time period of the duration, ending with end_time. Default is "now".
+      def create_snapshot(options = {})
+        url = "snapshots"
+        response = connection.post do |request|
+          request.url connection.build_url(url)
+          request.body = SmartJSON.write(options)
+        end
+        parsed = SmartJSON.read(response.body)
+      end
+
+      # Retrive a snapshot, to check its progress or find its image_href
+      #
+      # @example Get a snapshot identified by 42
+      #   Librato::Metrics.get_snapshot 42
+      #
+      # @param [Integer|String] id
+      def get_snapshot(id)
+        url = "snapshots/#{id}"
+        response = connection.get(url)
+        parsed = SmartJSON.read(response.body)
+      end
+
     private
 
       def default_faraday_adapter

data/lib/librato/metrics/version.rb

@@ -1,5 +1,5 @@
 module Librato
   module Metrics
-    VERSION = "1.3.2"
+    VERSION = "1.4.0"
   end
 end

data/spec/integration/metrics_spec.rb

@@ -355,5 +355,35 @@ module Librato
 
     end
 
+    describe "Snapshots API" do
+
+      let(:instrument_id) do
+        instrument_options = {name: "Snapshot test subject"}
+        conn = Metrics.connection
+        resp = conn.post do |req|
+          req.url conn.build_url("/v1/instruments")
+          req.body = Librato::Metrics::SmartJSON.write(instrument_options)
+        end
+        instrument_id = Librato::Metrics::SmartJSON.read(resp.body)["id"]
+      end
+
+      let(:subject) do
+        {instrument: {href: "http://api.librato.dev/v1/instruments/#{instrument_id}"}}
+      end
+
+      it "should #create_snapshot" do
+        result = Metrics.create_snapshot(subject: subject)
+        result["href"].should =~ /snapshots\/\d+$/
+      end
+
+      it "should #get_snapshot" do
+        result = Metrics.create_snapshot(subject: subject)
+        snapshot_id = result["href"][/(\d+)$/]
+
+        result = Metrics.get_snapshot(snapshot_id)
+        result["href"].should =~ /snapshots\/\d+$/
+      end
+    end
+
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: librato-metrics
 version: !ruby/object:Gem::Version
-  version: 1.3.2
+  version: 1.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -37,7 +37,7 @@ cert_chain:
   bktaNmhlblFBRjFDSDk2WmNxY0pIMTc5UzJ0SWlLRE04a2VlUklVT1BDM1dU
   MGZhb2svMgpnQTJvemRyODUxYy9uQT09Ci0tLS0tRU5EIENFUlRJRklDQVRF
   LS0tLS0K
-date: 2014-04-14 00:00:00.000000000 Z
+date: 2014-05-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -251,7 +251,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3482606803820656168
+      hash: -879066088464311398
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: