librato-metrics 1.4.0 → 1.5.0

data/.travis.yml

@@ -1,10 +1,10 @@
 rvm:
-  - 1.8.7
-  - ree
+  # - 1.8.7
+  # - ree
   - 1.9.2
   - 1.9.3
   - 2.0.0
-  - 2.1.1
+  - 2.1.2
   - jruby-19mode
   # - rbx
   - ruby-head
@@ -15,4 +15,9 @@ matrix:
 
 branches:
   except:
-    - /^v[0-9]/
+    - /^v[0-9]/
+
+notifications:
+  email:
+    on_failure: change
+    on_success: never

data/CHANGELOG.md

@@ -1,5 +1,8 @@
 ## Changelog
 
+### Version 1.5.0
+* Add #get_composite for easier fetching of composite measurements
+
 ### Version 1.4.0
 * Add support for snapshots
 

data/Gemfile

@@ -17,5 +17,19 @@ end
 
 gemspec
 
+gem 'rake'
+
+# docs
+gem 'yard'
+
+# debugging
+gem 'pry'
+
 # easily generate test data
 gem 'quixote'
+
+group :test do
+  gem 'rspec', '~> 2.6.0'
+  gem 'sinatra'
+  gem 'popen4'
+end

data/README.md

@@ -212,7 +212,11 @@ Get the 20 most recent 15 minute data point rollups for `temperature`:
 
     data = Librato::Metrics.get_measurements :temperature, :count => 20, :resolution => 900
 
-There are many more options supported for querying, take a look at the [REST API docs](http://dev.librato.com/v1/get/gauges/:name) or the [`get_metric`](http://rubydoc.info/github/librato/librato-metrics/master/Librato/Metrics/Client#get_metric-instance_method)/[`get_measurements`](http://rubydoc.info/github/librato/librato-metrics/master/Librato/Metrics/Client#get_measurements-instance_method) documentation for more details.
+Get the 5 minute moving average for `temperature` for the last hour, assuming temperature is submitted once per minute:
+
+    data = Librato::Metrics.get_composite 'moving_average(mean(series("temperature", "*"), {size: "5"}))', :start_time => Time.now.to_i - 60*60, :resolution => 300
+
+There are many more options supported for querying, take a look at the [REST API docs](http://dev.librato.com/v1/get/metrics/:name) or the individual method documentation for more details.
 
 ## Setting Metric Properties
 

data/lib/librato/metrics.rb

@@ -76,7 +76,7 @@ module Librato
                    :api_endpoint=, :authenticate, :connection,
                    :faraday_adapter, :faraday_adapter=,
                    :persistence, :persistence=, :persister,
-                   :get_metric, :get_measurements, :metrics,
+                   :get_composite, :get_metric, :get_measurements, :metrics,
                    :delete_metrics, :update_metric, :update_metrics,
                    :submit,
                    :sources, :get_source, :update_source,

data/lib/librato/metrics/client.rb

@@ -163,13 +163,37 @@ module Librato
         options.empty? ? metric : metric["measurements"]
       end
 
+      # Retrieve measurements for a given composite metric definition.
+      # :start_time and :resolution are required options, :end_time is
+      # optional.
+      #
+      # @example Get 5m moving average of 'foo'
+      #   measurements = Librato::Metrics.get_composite
+      #     'moving_average(mean(series("foo", "*"), {size: "5"}))',
+      #     :start_time => Time.now.to_i - 60*60, :resolution => 300
+      #
+      # @param [String] definition Composite definition
+      # @param [hash] options Query options
+      def get_composite(definition, options={})
+        unless options[:start_time] && options[:resolution]
+          raise "You must provide a :start_time and :resolution"
+        end
+        query = options.dup
+        query[:compose] = definition
+        url = connection.build_url("metrics", query)
+        response = connection.get(url)
+        parsed = SmartJSON.read(response.body)
+        # TODO: pagination support
+        parsed
+      end
+
       # Retrieve a specific metric by name, optionally including data points
       #
       # @example Get attributes for a metric
       #   metric = Librato::Metrics.get_metric :temperature
       #
       # @example Get a metric and its 20 most recent data points
-      #   metric = Librato::Metrics.fetch :temperature, :count => 20
+      #   metric = Librato::Metrics.get_metric :temperature, :count => 20
       #   metric['measurements'] # => {...}
       #
       # A full list of query parameters can be found in the API
@@ -238,10 +262,10 @@ module Librato
       # List currently existing metrics
       #
       # @example List all metrics
-      #   Librato::Metrics.list
+      #   Librato::Metrics.metrics
       #
       # @example List metrics with 'foo' in the name
-      #   Librato::Metrics.list :name => 'foo'
+      #   Librato::Metrics.metrics :name => 'foo'
       #
       # @param [Hash] options
       def metrics(options={})

data/lib/librato/metrics/version.rb

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

data/librato-metrics.gemspec

@@ -29,14 +29,6 @@ Gem::Specification.new do |s|
   s.add_dependency 'multi_json'
   s.add_dependency 'aggregate', '~> 0.2.2'
 
-  ## development dependencies
-  s.add_development_dependency 'rake'
-  s.add_development_dependency 'rspec', '~> 2.6.0'
-  s.add_development_dependency 'pry'
-  s.add_development_dependency 'yard'
-  s.add_development_dependency 'sinatra'
-  s.add_development_dependency 'popen4'
-
   # omitting for now because jruby-19mode can't handle
   #s.add_development_dependency 'rdiscount' # for yard
 

data/spec/integration/metrics_spec.rb

@@ -355,35 +355,38 @@ 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
+    # Note: These are challenging to test end-to-end, should probably
+    # unit test instead. Disabling for now.
+    #
+    # 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.4.0
+  version: 1.5.0
   prerelease: 
 platform: ruby
 authors:
@@ -37,7 +37,7 @@ cert_chain:
   bktaNmhlblFBRjFDSDk2WmNxY0pIMTc5UzJ0SWlLRE04a2VlUklVT1BDM1dU
   MGZhb2svMgpnQTJvemRyODUxYy9uQT09Ci0tLS0tRU5EIENFUlRJRklDQVRF
   LS0tLS0K
-date: 2014-05-21 00:00:00.000000000 Z
+date: 2014-11-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -87,102 +87,6 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 0.2.2
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 2.6.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 2.6.0
-- !ruby/object:Gem::Dependency
-  name: pry
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: yard
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: sinatra
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: popen4
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
 description: An easy to use ruby wrapper for Librato's Metrics API
 email: matt@librato.com
 executables: []
@@ -251,7 +155,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -879066088464311398
+      hash: -1761741790277116379
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:

metadata.gz.sig

@@ -1 +1,7 @@
-o��y���9���8)�K�����c��2`�+`��ߣ�W���5قh,"�lZ@�G`-,{�ך�!E&�t��e�V6�[ጓ�M�������U"��Y�P�d����_��>����&��r|�ٻů��F�zw�,ʹ�T�h2dcM��
+���O
+VڬG�������
+��)�K2
�á���<ө�Ԕ����)�^a�����Pun��%w�U�ML��
+f)���	�Uʨ��9j�t�����NE�
+>�02��nTx
��F��Z&摽z�Վ�Z�I�"��q���;�)���n��4�~�WP
+�̹���E'��H�
+˃ps��ov\أ�Jy����h�d*0h