rjmetrics-client 0.4.0 → 0.5.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    NjliNDE1YjI2NzUwMDc3Y2IzNGVhNmRhMjkwZDk0ZjMwZjk4NzVhMg==
-  data.tar.gz: !binary |-
-    ZGRhNjNjMTUzNTk3MDJkOGVkZjlhNDkzZWNhNzU5ZjA4YjRkOTlhMg==
+SHA1:
+  metadata.gz: 17d4ec2cdea59b39c5945c6e960a6cf20f50609a
+  data.tar.gz: 31942dc32da373d613f89d9166fc46a16003dea5
 SHA512:
-  metadata.gz: !binary |-
-    ZmNmYWVkZGU1MTRjMTZiMTI3ZmJkY2MxMDBmZjY2MWQ3MjU4MDZmZjA3MDdl
-    YmRiOTkyYjY2YzJiOGFhODczOTc0ODM3MTJiNTAxZmRlNWEwMTkzN2MzMzUz
-    YTY0NzQ5YmE1ZDcwZjIxZjFjNjQyNGQ3NWVjNzQxNDc0Y2JiNzU=
-  data.tar.gz: !binary |-
-    YTUyMGZjNTYyOGQ0MTE3YmU4YzNiMTM3NDI4NTJhOGQ4OTQyNDYxN2ExMmMy
-    Nzk2ODQyMTYyNzY0ZDE0NWI3MjI0OTgyZjk1NzA1N2RjZDU3NjFlNzVjYzRh
-    MzNiM2YyM2NhNWZkYTc4ZmRkN2RkNWMyZjY5MTE4Y2I0ZmRmYjE=
+  metadata.gz: b1d848013b20153c79260f14bf0588cbc9c61a90c07297d240ded14da18eeaceb9d966cfdb9d5eaade0a6e9b4eb45d5a6065546f8b6a519869c3b7a63f2dcf79
+  data.tar.gz: 94c14efb7709725ab6470e027c86a9dfb2d8e80f5f70734090888d55ec9724fd49a8cfda3de8f38499d767bb44e638b61a0a882a31562db47e16a590bfeb0214

data/lib/rjmetrics-client/client.rb

@@ -4,119 +4,125 @@ require 'rest_client'
 require 'json'
 require 'enumerator'
 
-class Client
-
- # default RJMetrics Data Import API url
- API_BASE = "https://connect.rjmetrics.com/v2"
- # RJMetrics Sandbox API url
- SANDBOX_BASE = "https://sandbox-connect.rjmetrics.com/v2"
- # Datapoints to push at a time
- BATCH_SIZE = 100
-
-  # Constructs a Client instance if it receives valid arguments or will raise an ArgumentError.
-  #
-  # @param client_id [Integer] your RJMetrics Client ID
-  # @param api_key [String] your RJMetrics API Key
-  # @param timeout_in_seconds [Integer] seconds to wait for API responses or nil
-  def initialize(client_id, api_key, timeout_in_seconds = 10)
-    validateConstructorArgs(client_id, api_key, timeout_in_seconds)
-    @client_id = client_id
-    @api_key = api_key
-    @timeout_in_seconds = timeout_in_seconds
-  end
+module RJMetrics
+
+  class Client
+
+
+   # default RJMetrics Data Import API url
+   API_BASE = "https://connect.rjmetrics.com/v2"
+   # RJMetrics Sandbox API url
+   SANDBOX_BASE = "https://sandbox-connect.rjmetrics.com/v2"
+   # Datapoints to push at a time
+   BATCH_SIZE = 100
+   # Timout Seconds
+   DEFAULT_TIMEOUT_SECONDS = 10
+
+    # Constructs a Client instance if it receives valid arguments or will raise an ArgumentError.
+    #
+    # @param client_id [Integer] your RJMetrics Client ID
+    # @param api_key [String] your RJMetrics API Key
+    # @param timeout_in_seconds [Integer] seconds to wait for API responses
+    def initialize(client_id, api_key, timeout_in_seconds = DEFAULT_TIMEOUT_SECONDS)
+      validateConstructorArgs(client_id, api_key, timeout_in_seconds)
+      @client_id = client_id
+      @api_key = api_key
+      @timeout_in_seconds = timeout_in_seconds
+    end
 
-  # Checks if the provided Client ID and API Key are valid credentials by requesting from the RJMetrics API Sandbox.
-  def authenticated?
-    test_data = {:keys => [:id], :id => 1}
-    begin
-      pushData("test", test_data, SANDBOX_BASE)
-    rescue InvalidRequestException
-      return false
+    # Checks if the provided Client ID and API Key are valid credentials by requesting from the RJMetrics API Sandbox.
+    def authenticated?
+      test_data = {:keys => [:id], :id => 1}
+      begin
+        pushData("test", test_data, SANDBOX_BASE)
+      rescue InvalidRequestException
+        return false
+      end
+      return true
     end
-    return true
-  end
 
-  # Sends data to RJMetrics Data Import API in batches of 100.
-  #
-  # @param table_name [String] the table name you wish to store the data
-  # @param data [Hashamp] or Array of Hashmaps of data points that will get sent
-  # @param url [String] Import API url or nil
-  # @return [Array] results of each request to RJMetrics Data Import API
-  def pushData(table_name, data, url = API_BASE)
-    responses = Array.new
-    validatePushDataArgs(table_name, data, url)
-
-    if not data.is_a? Array
-      data = Array.[](data)
+    # Sends data to RJMetrics Data Import API in batches of 100.
+    #
+    # @param table_name [String] the table name you wish to store the data
+    # @param data [Hashamp] or Array of Hashmaps of data points that will get sent
+    # @param url [String] Import API url
+    # @return [Array] results of each request to RJMetrics Data Import API
+    def pushData(table_name, data, url = API_BASE)
+      responses = Array.new
+      validatePushDataArgs(table_name, data, url)
+
+      if not data.is_a? Array
+        data = Array.[](data)
+      end
+
+      data.each_slice(BATCH_SIZE) {|batch_data|
+        responses << makePushDataAPICall(table_name, batch_data, url)
+      }
+      return responses
     end
 
-    data.each_slice(BATCH_SIZE) {|batch_data|
-      puts "pushing batch of #{batch_data.count} data points"
-      responses << makePushDataAPICall(table_name, batch_data, url)
-    }
-    return responses
-  end
+    private
 
-  private
+    def validateConstructorArgs(client_id, api_key, timeout_in_seconds)
+      if not client_id.is_a? Integer or client_id <= 0
+        raise ArgumentError, "Invalid client ID: #{client_id} -- must be a positive integer."
+      end
 
-  def validateConstructorArgs(client_id, api_key, timeout_in_seconds)
-    if not client_id.is_a? Integer or client_id <= 0
-      raise ArgumentError, "Invalid client ID: #{client_id} -- must be a positive integer."
-    end
+      if not timeout_in_seconds.is_a? Integer or timeout_in_seconds <= 0
+        raise ArgumentError, "Invalid timeout: #{timeout_in_seconds} -- must be a positive integer."
+      end
 
-    if not timeout_in_seconds.is_a? Integer or timeout_in_seconds <= 0
-      raise ArgumentError, "Invalid timeout: #{timeout_in_seconds} -- must be a positive integer."
+      if not api_key.is_a? String
+        raise ArgumentError, "Invalid API key: #{api_key} -- must be a string."
+      end
     end
 
-    if not api_key.is_a? String
-      raise ArgumentError, "Invalid API key: #{api_key} -- must be a string."
-    end
-  end
+    def validatePushDataArgs(table_name, data, url)
+      if not data.is_a? Hash and not data.is_a? Array
+        raise ArgumentError, "Invalid data -- must be a valid Ruby Hash or Array."
+      end
 
-  def validatePushDataArgs(table_name, data, url)
-    if not data.is_a? Hash and not data.is_a? Array
-      raise ArgumentError, "Invalid data -- must be a valid Ruby Hash or Array."
-    end
+      if not table_name.is_a? String
+        raise ArgumentError, "Invalid table name: '#{table_name}' -- must be a string."
+      end
 
-    if not table_name.is_a? String
-      raise ArgumentError, "Invalid table name: '#{table_name}' -- must be a string."
+      if not url.is_a? String
+        raise ArgumentError, "Invalid url: '#{url}' -- must be a string."
+      end
     end
 
-    if not url.is_a? String
-      raise ArgumentError, "Invalid url: '#{url}' -- must be a string."
-    end
-  end
+    def makePushDataAPICall(table_name, data, url = API_BASE)
+      request_url = "#{url}/client/#{@client_id}/table/#{table_name}/data?apikey=#{@api_key}"
 
-  def makePushDataAPICall(table_name, data, url = API_BASE)
-    request_url = "#{url}/client/#{@client_id}/table/#{table_name}/data?apikey=#{@api_key}"
-
-    begin
-      response = RestClient.post(
-        request_url,
-        data.to_json,
-        {
-          :content_type => :json,
-          :accept => :json,
-          :timeout => @timeout_in_seconds
-        }
-      )
-      return response
-    rescue RestClient::Exception => error
       begin
-        response = JSON.parse(error.response)
-        raise InvalidRequestException,
-          "The Import API returned: #{response['code']} #{response['message']}. Reasons: #{response['reasons']}"
-      rescue JSON::ParserError, TypeError => e
-        raise InvalidResponseException,
-          "RestClientError: #{error.class}, With response: #{error.response}"
+        response = RestClient.post(
+          request_url,
+          data.to_json,
+          {
+            :content_type => :json,
+            :accept => :json,
+            :timeout => @timeout_in_seconds
+          }
+        )
+        return response
+      rescue RestClient::Exception => error
+        begin
+          response = JSON.parse(error.response)
+          raise InvalidRequestException,
+            "The Import API returned: #{response['code']} #{response['message']}. Reasons: #{response['reasons']}"
+        rescue JSON::ParserError, TypeError => json_parse_error
+          raise InvalidResponseException,
+            "RestClientError: #{error.class}, With response: #{error.response}"
+        end
       end
     end
-  end
 
-  class UnableToConnectException < RuntimeError
-  end
-  class InvalidRequestException < RuntimeError
-  end
-  class InvalidResponseException < RuntimeError
+    class UnableToConnectException < RuntimeError
+    end
+    class InvalidRequestException < RuntimeError
+    end
+    class InvalidResponseException < RuntimeError
+    end
+
   end
 end

data/lib/rjmetrics_client.rb

@@ -1,10 +1,17 @@
+require_relative 'rjmetrics-client/client'
+
 class RJMetricsClient
 
+  # Constructs a RJMetricsClient instance if it receives valid arguments or will raise an ArgumentError.
+  #
+  # @param client_id [Integer] your RJMetrics Client ID
+  # @param api_key [String] your RJMetrics API Key
+  # @param timeout_in_seconds [Integer] seconds to wait for API responses
   def initialize(client_id, api_key, timeout_in_seconds = 10)
-    @client = Client.new(client_id, api_key, timeout_in_seconds)
+    @client = RJMetrics::Client.new(client_id, api_key, timeout_in_seconds)
 
     if not authenticated?
-      raise Client::UnableToConnectException, "Connection failed. Please double check your credentials."
+      raise RJMetrics::Client::UnableToConnectException, "Connection failed. Please double check your credentials."
     end
   end
 
@@ -17,10 +24,9 @@ class RJMetricsClient
   #
   # @param table_name [String] the table name you wish to store the data
   # @param data [Hashamp] or Array of Hashmaps of data points that will get sent
+  # @param url [String] Import API url
   # @return [Array] results of each request to RJMetrics Data Import API
-  def pushData(table_name, data)
-    @client.pushData(table_name, data)
+  def pushData(table_name, data, url = RJMetrics::Client::API_BASE)
+    @client.pushData(table_name, data, url)
   end
 end
-
-require 'rjmetrics-client/client'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rjmetrics-client
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Owen Jones
@@ -14,56 +14,56 @@ dependencies:
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.6.7
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.6.7
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.7.7
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.7.7
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>'
+    - - '>'
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>'
+    - - '>'
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>'
+    - - '>'
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>'
+    - - '>'
       - !ruby/object:Gem::Version
         version: '0'
 description: RJMetrics Data Import API Client Library
@@ -72,8 +72,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/rjmetrics-client/client.rb
 - lib/rjmetrics_client.rb
+- lib/rjmetrics-client/client.rb
 homepage: http://rjmetrics.com
 licenses:
 - Apache-2.0
@@ -84,18 +84,19 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.1
+rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
 summary: RJMetrics Data Import API Client Library
 test_files: []
+has_rdoc: