rjmetrics-client 0.1.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MGM2ZDMwYjRlZTljZWUzZTllMzdjMmVlMDIzNTc5NzdlNDYzMDRlYw==
+  data.tar.gz: !binary |-
+    YzMzMmFiNTIzYzZjNGNhYWNlNjBhN2M3NzY0YTJkYzVkM2U5ZTg3OA==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    ZjQ3NzhmNjkxMzUwMjBjODQ4MzJkODM3NWM3Mzc0MWJmMjJlY2M2ZThiOTA4
+    NDg0NGEyYTk5M2QyNmQ1MzA5YWEyNzJkYTA2NzA2NjE1OTZlNjI1ODAzYTc4
+    YTAzODY4ZTg3ZmYwMWNlMzlkMGY2YTdjZTNmYjlkNTY2NTRmYTk=
+  data.tar.gz: !binary |-
+    M2E3ZTViMjZmMzAxNTIxOTY4MTVlMDU5NzM1MDcwNDkwNTdkOGVlMDA4Nzdl
+    ZGNlZjBmOWI0NDNmZGJmMjAwYjQ3MTI1N2NmNWEwMWYyZmI5MTlkNjM4YzEz
+    OTI4YzI1OGNhYmUwMGNjNTAwMGNjZGJjMTM2NTdiNzZjYjY5OTc=

data/lib/rjmetrics-client/client.rb

@@ -0,0 +1,105 @@
+require 'rest_client'
+require 'json'
+
+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"
+
+  # 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
+
+  # Checks if the provided Client ID and API Key are valid credentials by requestin 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
+
+  # Sends data to RJMetrics Data Import API.
+  #
+  # @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)
+    validatePushDataArgs(table_name, data, url)
+
+    if not data.is_a? Array
+      data = Array.[](data)
+    end
+
+    return data.map{ |data_point| makePushDataAPICall(table_name, data_point, url) }
+  end
+
+  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
+
+    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 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
+
+    if not table_name.is_a? String
+      raise ArgumentError, "Invalid table name: '#{table_name}' -- must be a string."
+    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}"
+
+    begin
+      response = RestClient.post(
+        request_url,
+        data.to_json,
+        {
+          :content_type => :json,
+          :accept => :json,
+          :timeout => @timeout_in_seconds
+        }
+      )
+      return response
+    rescue RestClient::Exception => error
+      response = JSON.parse(error.response)
+      raise InvalidRequestException,
+        "The Import API returned: #{response['code']} #{response['message']}. Reasons: #{response['reasons']}"
+    end
+  end
+
+  class UnableToConnectException < RuntimeError
+  end
+  class InvalidRequestException < RuntimeError
+  end
+end

data/lib/rjmetrics_client.rb

@@ -0,0 +1,21 @@
+class RJMetricsClient
+
+  def initialize(client_id, api_key, timeout_in_seconds = 10)
+    @client = Client.new(client_id, api_key, timeout_in_seconds)
+
+    if not @client.authenticated?
+      raise Client::UnableToConnectException, "Connection failed. Please double check your credentials."
+    end
+  end
+
+  # Sends data to RJMetrics Data Import API.
+  #
+  # @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
+  # @return [Array] results of each request to RJMetrics Data Import API
+  def pushData(table_name, data)
+    @client.pushData(table_name, data)
+  end
+end
+
+require 'rjmetrics-client/client'

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: rjmetrics-client
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Owen Jones
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  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
+email: ojones@rjmetrics.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/rjmetrics_client.rb
+- lib/rjmetrics-client/client.rb
+homepage: http://rjmetrics.com
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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.0.7
+signing_key: 
+specification_version: 4
+summary: RJMetrics Data Import API Client Library
+test_files: []