wavefront-sdk 0.0.1 → 0.1.0

data/lib/wavefront-sdk/source.rb

@@ -4,7 +4,7 @@ module Wavefront
   #
   # View and manage source metadata.
   #
-  class Source < Wavefront::Base
+  class Source < Base
 
     # GET /api/v2/source
     # Get all sources for a customer
@@ -30,7 +30,7 @@ module Wavefront
       api_post('', body, 'application/json')
     end
 
-    # DELETE /api/v2/source/{id}
+    # DELETE /api/v2/source/id
     # Delete metadata (description and tags) for a specific source.
     #
     # @param id [String] ID of the source
@@ -41,7 +41,7 @@ module Wavefront
       api_delete(id)
     end
 
-    # GET /api/v2/source/{id}
+    # GET /api/v2/source/id
     # Get a specific source for a customer.
     #
     # @param id [String] ID of the source
@@ -55,7 +55,7 @@ module Wavefront
       api_get(fragments.uri_concat)
     end
 
-    # PUT /api/v2/source/{id}
+    # PUT /api/v2/source/id
     # Update metadata (description or tags) for a specific source.
     #
     # Refer to the Swagger API docs for valid keys.
@@ -69,11 +69,11 @@ module Wavefront
       api_put(id, body)
     end
 
-    # GET /api/v2/source/{id}/tag
+    # GET /api/v2/source/id/tag
     # Get all tags associated with a specific source.
     #
     # @param id [String] ID of the source
-    # @returns [Hash] object describing the source with status and
+    # @return [Hash] object describing the source with status and
     #   response keys
     #
     def tags(id)
@@ -81,12 +81,12 @@ module Wavefront
       api_get([id, 'tag'].uri_concat)
     end
 
-    # POST /api/v2/source/{id}/tag
+    # POST /api/v2/source/id/tag
     # Set all tags associated with a specific source.
     #
     # @param id [String] ID of the source
     # @param tags [Array] list of tags to set.
-    # @returns [Hash] object describing the source with status and
+    # @return [Hash] object describing the source with status and
     #   response keys
     #
     def tag_set(id, tags)
@@ -96,12 +96,12 @@ module Wavefront
       api_post([id, 'tag'].uri_concat, tags.to_json, 'application/json')
     end
 
-    # DELETE /api/v2/source/{id}/tag/{tagValue}
+    # DELETE /api/v2/source/id/tag/tagValue
     # Remove a tag from a specific source.
     #
     # @param id [String] ID of the source
     # @param tag [String] tag to delete
-    # @returns [Hash] object with 'status' key and empty 'repsonse'
+    # @return [Hash] object with 'status' key and empty 'repsonse'
     #
     def tag_delete(id, tag)
       wf_source_id?(id)
@@ -109,12 +109,12 @@ module Wavefront
       api_delete([id, 'tag', tag].uri_concat)
     end
 
-    # PUT /api/v2/source/{id}/tag/{tagValue}
+    # PUT /api/v2/source/id/tag/tagValue
     # Add a tag to a specific source
     #
     # @param id [String] ID of the source
     # @param tag [String] tag to set.
-    # @returns [Hash] object with 'status' key and empty 'repsonse'
+    # @return [Hash] object with 'status' key and empty 'repsonse'
     #
     def tag_add(id, tag)
       wf_source_id?(id)
@@ -122,10 +122,4 @@ module Wavefront
       api_put([id, 'tag', tag].uri_concat)
     end
   end
-
-  # A standard response
-  #
-  class Response
-    class Source < Base; end
-  end
 end

data/lib/wavefront-sdk/user.rb

@@ -4,7 +4,7 @@ module Wavefront
   #
   # Manage and query Wavefront users
   #
-  class User < Wavefront::Base
+  class User < Base
 
     # GET /api/v2/user
     # Get all users.
@@ -26,7 +26,7 @@ module Wavefront
       api_post("?sendEmail=#{send_email}", body, 'application/json')
     end
 
-    # DELETE /api/v2/user/{id}
+    # DELETE /api/v2/user/id
     # Delete a specific user.
     #
     # @param id [String] ID of the user
@@ -37,7 +37,7 @@ module Wavefront
       api_delete(id)
     end
 
-    # GET /api/v2/user/{id}
+    # GET /api/v2/user/id
     # Retrieves a user by identifier (email addr).
     #
     # @param id [String] ID of the user
@@ -48,7 +48,7 @@ module Wavefront
       api_get(id)
     end
 
-    # PUT /api/v2/user/{id}/grant
+    # PUT /api/v2/user/id/grant
     # Grants a specific user permission.
     #
     # @param id [String] ID of the user
@@ -68,7 +68,7 @@ module Wavefront
                'application/x-www-form-urlencoded')
     end
 
-    # PUT /api/v2/user/{id}/revoke
+    # PUT /api/v2/user/id/revoke
     # Revokes a specific user permission.
     #
     # @param id [String] ID of the user
@@ -83,26 +83,17 @@ module Wavefront
       api_post([id, 'revoke'].uri_concat, "group=#{group}",
                'application/x-www-form-urlencoded')
     end
-  end
-
-  class Response
 
-    # The User response forges status and response methods to look
-    # like other classes and create a more consistent interface.
+    # Fake a response which looks like we get from all the other
+    # paths. I'm expecting the user response model to be made
+    # consistent with others in the future.
     #
-    class User < Base
-      def populate(raw, status)
-        @response = if raw.is_a?(Array)
-                      Struct.new(:items).new(raw).freeze
-                    elsif raw.is_a?(Hash)
-                      Struct.new(*raw.keys).new(*raw.values).freeze
-                    end
-
-        result = status == 200 ? 'OK' : 'ERROR'
-
-        @status = Struct.new(:result, :message, :code).
-            new(result, nil, status)
-      end
+    def response_shim(body, status)
+      { response: JSON.parse(body),
+        status:   { result:  status == 200 ? 'OK' : 'ERROR',
+                    message: '',
+                    code:    status },
+      }.to_json
     end
   end
 end

data/lib/wavefront-sdk/validators.rb

@@ -141,7 +141,7 @@ module Wavefront
 
     # Ensure the given argument is a valid version number
     #
-    # @param [Integer] the version number to validate
+    # @param v [Integer] the version number to validate
     # @return True if the version is valid
     # @raise Wavefront::Exception::InvalidVersion if the alert ID is
     #   not valid
@@ -245,7 +245,7 @@ module Wavefront
     #   event ID is not valid
     #
     def wf_event_id?(v)
-      return true if v.is_a?(String) && v =~ /^\d{13}:[\w\- ]+$/
+      return true if v.is_a?(String) && v =~ /^\d{13}:.+/
       raise Wavefront::Exception::InvalidEventId
     end
 

data/lib/wavefront-sdk/version.rb

@@ -1 +1 @@
-WF_SDK_VERSION = '0.0.1'.freeze
+WF_SDK_VERSION = '0.1.0'.freeze

data/lib/wavefront-sdk/webhook.rb

@@ -4,7 +4,7 @@ module Wavefront
   #
   # Manage and query Wavefront webhooks
   #
-  class Webhook < Wavefront::Base
+  class Webhook < Base
 
     # GET /api/v2/webhook
     # Get all webhooks for a customer.
@@ -29,7 +29,7 @@ module Wavefront
       api_post('', body, 'application/json')
     end
 
-    # DELETE /api/v2/webhook/{id}
+    # DELETE /api/v2/webhook/id
     # Delete a specific webhook.
     #
     # @param id [String, Integer] ID of the webhook
@@ -40,7 +40,7 @@ module Wavefront
       api_delete(id)
     end
 
-    # GET /api/v2/webhook/{id}
+    # GET /api/v2/webhook/id
     # Get a specific webhook.
     #
     # @param id [String, Integer] ID of the webhook
@@ -51,7 +51,7 @@ module Wavefront
       api_get(id)
     end
 
-    # PUT /api/v2/webhook/{id}
+    # PUT /api/v2/webhook/id
     # Update a specific webhook.
     #
     # @param body [Hash] a hash of parameters describing the webhook.
@@ -64,10 +64,4 @@ module Wavefront
       api_put(id, body)
     end
   end
-
-  # A standard response
-  #
-  class Response
-    class Webhook < Base; end
-  end
 end

data/lib/wavefront-sdk/write.rb

@@ -8,13 +8,14 @@ module Wavefront
   # This class helps you send points to a Wavefront proxy in native
   # format. Usually this is done on port 2878.
   #
-  class Write < Wavefront::Base
+  class Write < Base
     attr_reader :sock, :summary
 
     # Construct an object which allows us to write points to a
     # Wavefront proxy.
     #
-    # @pram creds [Hash] must contain the keys endpoint: and port.
+    # @param _creds [Hash] dummy parameter for correct method
+    #   signature.
     # @param options [Hash] can contain the following keys:
     #   proxy [String] the address of the Wavefront proxy. ('wavefront')
     #   port [Integer] the port of the Wavefront proxy (2878)
@@ -48,10 +49,13 @@ module Wavefront
     # Send raw data to a Wavefront proxy, automatically opening and
     # closing a socket.
     #
-    # @param point [Array[String]] an array of points in native
+    # @param points [Array[String]] an array of points in native
     #   Wavefront wire format, as described in
     #   https://community.wavefront.com/docs/DOC-1031. No validation
     #   is performed.
+    # @param openclose [Boolean] whether or not to automatically
+    #   open a socket to the proxy before sending points, and
+    #   afterwards, close it.
     #
     def raw(points, openclose = true)
       open if openclose
@@ -95,7 +99,13 @@ module Wavefront
         close if openclose
       end
 
-      Wavefront::Response::Write.new(summary.to_json, nil)
+      s_str = summary[:unsent] == 0 && summary[:rejected] == 0 ? 'OK' :
+                                                                 'ERROR'
+
+      resp = { status:   { result: s_str, message: nil, code: nil },
+               response: summary }.to_json
+
+      Wavefront::Response.new(resp, nil)
     end
 
     def valid_point?(p)
@@ -202,7 +212,7 @@ module Wavefront
     end
   end
 
-  class Response
+  #class Response
     # The Write response forges status and response methods to look
     # like other classes and create a more consistent interface. As
     # the request does not happen over HTTP, there's not much to put
@@ -212,14 +222,14 @@ module Wavefront
     # @response=#<struct  sent=1, rejected=0, unsent=0>,
     # @status=#<struct  result="OK", message=nil, code=nil>>
     #
-    class Write < Base
-      def populate(raw, status)
-        @response = Struct.new(*raw.keys).new(*raw.values).freeze
-
-        ok = raw[:rejected] == 0 && raw[:unsent] == 0 ? 'OK' : 'ERROR'
-
-        @status = Struct.new(:result, :message, :code).new(ok, nil, nil)
-      end
-    end
-  end
+    #class Write < Base
+      #def populate(raw, status)
+        #@response = Struct.new(*raw.keys).new(*raw.values).freeze
+#
+        #ok = raw[:rejected] == 0 && raw[:unsent] == 0 ? 'OK' : 'ERROR'
+#
+        #@status = Struct.new(:result, :message, :code).new(ok, nil, nil)
+      #end
+    #end
+  #end
 end

data/spec/wavefront-sdk/credentials_spec.rb

@@ -16,11 +16,11 @@ class WavefrontCredentialsTest < MiniTest::Test
     ENV.delete('WAVEFRONT_TOKEN')
     c = Wavefront::Credentials.new(file: CONF)
     assert_instance_of(Wavefront::Credentials, c)
-    assert_instance_of(Hash, c.creds)
-    assert_instance_of(Hash, c.proxy)
-    assert_instance_of(Hash, c.config)
+    assert_instance_of(Map, c.creds)
+    assert_instance_of(Map, c.proxy)
+    assert_instance_of(Map, c.config)
 
-    assert_equal(c.creds.keys, [:token, :endpoint])
+    assert_equal(c.creds.keys, %w(token endpoint))
     assert_equal(c.creds[:token], '12345678-abcd-1234-abcd-123456789012')
     assert_equal(c.creds[:endpoint], 'default.wavefront.com')
   end
@@ -30,11 +30,11 @@ class WavefrontCredentialsTest < MiniTest::Test
     ENV['WAVEFRONT_TOKEN'] = 'abcdefgh'
     c = Wavefront::Credentials.new(file: CONF)
     assert_instance_of(Wavefront::Credentials, c)
-    assert_instance_of(Hash, c.creds)
-    assert_instance_of(Hash, c.proxy)
-    assert_instance_of(Hash, c.config)
+    assert_instance_of(Map, c.creds)
+    assert_instance_of(Map, c.proxy)
+    assert_instance_of(Map, c.config)
 
-    assert_equal(c.creds.keys, [:token, :endpoint])
+    assert_equal(c.creds.keys, %w(token endpoint))
     assert_equal(c.creds[:token], 'abcdefgh')
     assert_equal(c.creds[:endpoint], 'default.wavefront.com')
   end
@@ -44,11 +44,11 @@ class WavefrontCredentialsTest < MiniTest::Test
     ENV['WAVEFRONT_ENDPOINT'] = 'endpoint.wavefront.com'
     c = Wavefront::Credentials.new(file: CONF)
     assert_instance_of(Wavefront::Credentials, c)
-    assert_instance_of(Hash, c.creds)
-    assert_instance_of(Hash, c.proxy)
-    assert_instance_of(Hash, c.config)
+    assert_instance_of(Map, c.creds)
+    assert_instance_of(Map, c.proxy)
+    assert_instance_of(Map, c.config)
 
-    assert_equal(c.creds.keys, [:token, :endpoint])
+    assert_equal(c.creds.keys, %w(token endpoint))
     assert_equal(c.creds[:token], '12345678-abcd-1234-abcd-123456789012')
     assert_equal(c.creds[:endpoint], 'endpoint.wavefront.com')
   end

data/spec/wavefront-sdk/response_spec.rb

@@ -13,8 +13,8 @@ WF_JSON = '{"status":{"result":"OK","message":"","code":200},' \
 class WavefrontResponseTest < MiniTest::Test
 
   def test_initialize_good_data
-    wf = Wavefront::Response::Base.new(WF_JSON, 200)
-    assert_instance_of(Wavefront::Response::Base, wf)
+    wf = Wavefront::Response.new(WF_JSON, 200)
+    assert_instance_of(Wavefront::Response, wf)
     assert_respond_to(wf, :status)
     assert_respond_to(wf, :response)
     assert_respond_to(wf.response, :items)
@@ -25,22 +25,22 @@ class WavefrontResponseTest < MiniTest::Test
   end
 
   def test_initialize_bad_data
-    assert_raises(Wavefront::Exception::InvalidResponse) do
-      Wavefront::Response::Base.new('merp', 200)
+    assert_raises(Wavefront::Exception::UnparseableResponse) do
+      Wavefront::Response.new('merp', 200)
     end
 
-    assert_raises(Wavefront::Exception::InvalidResponse) do
-      Wavefront::Response::Base.new(
+    assert_raises(Wavefront::Exception::UnparseableResponse) do
+      Wavefront::Response.new(
         '{"status":{"result":"OK","message":"","code":200}', 200)
     end
 
-    assert_raises(Wavefront::Exception::InvalidResponse) do
-      Wavefront::Response::Base.new(
+    assert_raises(Wavefront::Exception::UnparseableResponse) do
+      Wavefront::Response.new(
         '{"status":{"result":"OK","message":"","code":200}', 200)
     end
 
-    assert_raises(Wavefront::Exception::InvalidResponse) do
-      Wavefront::Response::Base.new(
+    assert_raises(Wavefront::Exception::UnparseableResponse) do
+      Wavefront::Response.new(
         '{"response":{"items":[{"name":"test agent"}],"offset":0 }', 200)
     end
   end

data/spec/wavefront-sdk/validators_spec.rb

@@ -122,7 +122,7 @@ class WavefrontValidatorsTest < MiniTest::Test
 
   def test_wf_event_id?
     good = %w(1493370839062:test1)
-    bad = %w(1493370839062 1493370839062:test!)
+    bad = %w(1493370839062 1493370839062test!)
     good_and_bad('wf_event_id?', 'InvalidEventId', good, bad)
   end
 

data/wavefront-sdk.gemspec

@@ -21,6 +21,8 @@ Gem::Specification.new do |gem|
 
   gem.add_runtime_dependency 'faraday', '>= 0.12.1', '< 0.13'
   gem.add_runtime_dependency 'inifile', '>= 3.0.0'
+  gem.add_runtime_dependency 'addressable', '~> 2.4'
+  gem.add_runtime_dependency 'map', '~> 6.6.0'
 
   gem.add_development_dependency 'bundler', '~> 1.3'
   gem.add_development_dependency 'rake', '~> 12.0'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wavefront-sdk
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Robert Fisher
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-04 00:00:00.000000000 Z
+date: 2017-06-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -44,6 +44,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+- !ruby/object:Gem::Dependency
+  name: map
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.6.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -238,7 +266,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: SDK for Wavefront API v2