analytics-psw 0.3.2 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 96c6d8dedbbe05d08979926ec65355ec8135db01
-  data.tar.gz: ae99b561a809b3e975d3507fb92c8dc717ec9e77
+  metadata.gz: c5bd2ac49dc5a4f6a747f7ee132c50bc7d5f7fdb
+  data.tar.gz: cecfcc3fb2835f8ec0063208699444d3a323a7bc
 SHA512:
-  metadata.gz: ea389b6047349284da4c4926f891a36f75b345779302c16ec48055561246f3a41b96afb62e53cb9af381856f556aacfb3f1f0e048fbec4f57c968f83ec1d1838
-  data.tar.gz: 979d7eefcf976b5b20a0f9e1bd23dcfad0948f0dd729262a85b0eec3ef2d8d6bfc18233546eb794d077d3e5dede1fa5633287bf198c88aca0e92421d5a114b39
+  metadata.gz: 3ba8d918d1c2bd5d55afd34f23b1f707aa10560500c798db71905c51fcf9ec3e44820a4b8f40781f54525c235132def794cbf8c5ed0d637155e36308054478cf
+  data.tar.gz: e837e674a81bee0d9768d43d65f8a78d8be9b7e525feb27b3d52c406333313800198e7ba99e81348090cdd104be23052b47e32c0858ffb83ec265b216ee0cadc

data/lib/analytics-psw.rb

@@ -10,6 +10,7 @@ require 'analytics-psw/events'
 require 'analytics-psw/dimension_properties'
 require 'analytics-psw/dimensions'
 require 'analytics-psw/customers'
+require 'analytics-psw/utilities'
 
 module AnalyticsPSW
   class Analytics
@@ -20,15 +21,18 @@ module AnalyticsPSW
             AnalyticsPSW::EventTypes,
             AnalyticsPSW::Events,
             AnalyticsPSW::Dimensions,
-            AnalyticsPSW::DimensionProperties
+            AnalyticsPSW::DimensionProperties,
+            AnalyticsPSW::Utilities
 
     attr_accessor :service_location
 
     def initialize(opts = {})
       set_vars_from_opts(opts)
       @conn = faraday_connection
-      update_token if @client_id
+      update_token if @client_id && @client_secret
       @service_location = "#{@server_url}/services/#{@service_name}"
+      resp = http_request(:get, @service_location)
+      raise 'The service name provided does not appear to be valid' unless resp.status == 200
       find_or_create_event_types
       find_or_create_dimensions(@dimensions) if @dimensions
     end
@@ -46,144 +50,5 @@ module AnalyticsPSW
       @client_id = opts['client_id']
       @client_secret = opts['client_secret']
     end
-
-    def update_token
-      url = "#{@server_url}/oauth/token?client_id=#{@client_id}&client_secret=#{@client_secret}"
-      raw = post_json(url, 'token', {})
-      parse_raw = parse_json_response(raw)
-      resp = parse_raw['body']
-      @token = resp['access_token']
-    end
-
-    def get_json(url, params = {})
-       headers = @token ? {'Authorization' => "Bearer #{@token}"} : nil
-       @conn.get(url, params, headers)
-    end
-
-    def multi_get_json(service_location, query_parameters)
-      results = []
-
-      EventMachine.run do
-        multi = EventMachine::MultiRequest.new
-
-        connection_opts = {}
-        connection_opts = {proxy: {host: @proxy.sub(/^https?\:\/\//, ''), port: 80}} if @proxy.present?
-
-        query_parameters.each_with_index do |param, idx|
-          http = EventMachine::HttpRequest.new(service_location, connection_opts)
-          req = http.get query: param, head: {'Authorization' => "Bearer #{@token}"}
-          multi.add idx, req
-        end
-
-        multi.callback do
-          response = multi.responses[:callback]
-          error =  multi.responses[:errback]
-          EventMachine.stop
-
-          (0..query_parameters.size-1).each do |idx|
-            results += [multi_parse_json_response(response[idx])] if response[idx].present?
-            results += [multi_parse_json_response(error[idx])] if error[idx].present?
-          end
-        end
-      end
-
-      results
-    end
-
-    def post_json(url, object_type, metadata)
-      http_json(:post, url, object_type, metadata)
-    end
-
-    def put_json(url, object_type, metadata)
-      http_json(:put, url, object_type, metadata)
-    end
-
-    def http_json(http_method, url, object_type, metadata)
-      json_object = create_json_object(object_type, metadata)
-      json_block  = ->(req) do
-        req.url url
-        req.headers['Content-Type'] = 'application/json'
-        req.headers['Authorization']= "Bearer #{@token}" if @token
-        req.body = json_object
-      end
-      @conn.send(http_method, &json_block)
-    end
-
-    def create_json_object(object_type, metadata = {})
-      {object_type => metadata}.to_json
-    end
-
-    def create_metadata(hashmap)
-      hashmap.reject { |k,v| v == '' }
-    end
-
-    def find_or_create_event_types
-      all_event_types = get_all_events
-      new_events = @event_types - all_event_types
-      new_events.each do |event_type|
-        create_event_type(event_type)
-      end
-      @event_types |= all_event_types
-    end
-
-    def find_or_create_dimensions(dimensions)
-      all_dimensions = get_all_dimension_names
-      dimensions.each do |dimension|
-        dimension.each do |name, data_type|
-          unless all_dimensions.include?(name)
-            create_dimension(name, data_type)
-            all_dimensions << name
-          end
-        end
-      end
-      @dimensions = all_dimensions
-    end
-
-    def get_all_events
-      event_types = list_event_types['body']['event_types']
-      event_types ? event_types.map{|e| e['name']} : []
-    end
-
-    def get_all_dimension_names
-      dimensions = list_dimensions['body']['dimensions']
-      dimensions ? dimensions.map { |d| d['name']} : []
-    end
-
-    def parse_json_response(json_response)
-      parsed_response = {}
-      parsed_response['status'] = json_response.status if json_response.status.present?
-
-      if [200, 201, 202].include?(json_response.status)
-        parsed_response['body'] = JSON.parse(json_response.body) if json_response.body.present?
-        parsed_response['location'] = json_response.headers['location'] if json_response.headers.present? && json_response.headers['location']
-      else
-        parsed_response['body'] = {}
-        parsed_response['error_message'] = json_response.body
-      end
-
-      parsed_response
-    end
-
-    def multi_parse_json_response(response)
-      parsed_response = {}
-      parsed_response['status'] = response.response_header.present? ? response.response_header.status : 500
-
-      if [200, 201, 202].include?(parsed_response['status'])
-        parsed_response['body'] = JSON.parse response.response if response.response.present?
-        parsed_response['location'] = response.headers.location if response.headers.present? && response.headers.location.present?
-      else
-        parsed_response['body'] = {}
-        parsed_response['error_message'] = response.error if response.error.present?
-      end
-      parsed_response
-    end
-
-    def delete_resource(url)
-      @conn.delete (url + "?access_token=#{@token}")
-    end
-
-    def faraday_connection
-      @proxy ? Faraday.new(@server_url, {proxy: {uri: @proxy}}) : Faraday.new(@server_url)
-    end
   end
 end

data/lib/analytics-psw/customers.rb

@@ -1,7 +1,7 @@
 module AnalyticsPSW
   module Customers
     def list_customers
-      resp = get_json("#{@service_location}/customers")
+      resp = http_request(:get, "#{@service_location}/customers")
       parse_json_response(resp)
     end
   end

data/lib/analytics-psw/dimension_properties.rb

@@ -1,24 +1,26 @@
 module AnalyticsPSW
   module DimensionProperties
     def list_dimension_properties(dimension_name)
-      resp = get_json("#{@service_location}/dimensions/#{dimension_name}/properties")
+      resp = http_request(:get, "#{@service_location}/dimensions/#{dimension_name}/properties")
       parse_json_response(resp)
     end
 
     def show_dimension_properties(dimension_name, dimension_value)
-      resp = get_json("#{@service_location}/dimensions/#{dimension_name}/properties/#{dimension_value}")
+      resp = http_request(:get, "#{@service_location}/dimensions/#{dimension_name}/properties/#{dimension_value}")
       parse_json_response(resp)
     end
 
     def create_dimension_properties(dimension_name, dimension_value, properties = {})
       metadata = create_dimension_properties_metadata(dimension_value, properties)
-      response = post_json("#{@service_location}/dimensions/#{dimension_name}/properties/#{dimension_value}", 'dimension_property', metadata)
+      body = create_json_body('dimension_property', metadata)
+      response = http_request(:post, "#{@service_location}/dimensions/#{dimension_name}/properties/#{dimension_value}", nil, body)
       parse_json_response(response)
     end
 
     def update_dimension_properties(dimension_name, dimension_value, properties = {})
       metadata = create_dimension_properties_metadata(dimension_value, properties)
-      response = put_json("#{@service_location}/dimensions/#{dimension_name}/properties/#{dimension_value}", 'dimension_property', metadata)
+      body = create_json_body('dimension_property', metadata)
+      response = http_request(:put, "#{@service_location}/dimensions/#{dimension_name}/properties/#{dimension_value}", nil, body)
       parse_json_response(response)
     end
 

data/lib/analytics-psw/dimensions.rb

@@ -2,26 +2,45 @@ module AnalyticsPSW
   module Dimensions
 
     def create_dimension(name, data_type, units = '', description = '')
-      metadata = create_metadata({:name => name.to_s, :description => description, :data_type => data_type, :units => units})
-      resp = post_json("#{@service_location}/dimensions", "dimension", metadata)
+      body = create_json_body('dimension', {:name => name.to_s, :description => description, :data_type => data_type, :units => units})
+      resp = http_request(:post, "#{@service_location}/dimensions", nil, body)
       @dimensions |= [name.to_s] if resp.status && [200, 201, 202].include?(resp.status)
       parse_json_response(resp)
     end
 
     def list_dimensions
-      resp = get_json("#{@service_location}/dimensions")
+      resp = http_request(:get, "#{@service_location}/dimensions")
       parse_json_response(resp)
     end
 
     def show_dimension_resources(dimension_name)
-      resp = get_json("#{@service_location}/dimensions/#{dimension_name}")
+      resp = http_request(:get, "#{@service_location}/dimensions/#{dimension_name}")
       parse_json_response(resp)
     end
 
     def show_dimension_metadata(dimension_name)
-      resp = get_json("#{@service_location}/dimensions/#{dimension_name}/metadata")
+      resp = http_request(:get, "#{@service_location}/dimensions/#{dimension_name}/metadata")
       parse_json_response(resp)
     end
 
+    private
+
+    def find_or_create_dimensions(dimensions)
+      all_dimensions = get_dimension_names
+      dimensions.each do |dimension|
+        dimension.each do |name, data_type|
+          unless all_dimensions.include?(name)
+            create_dimension(name, data_type)
+            all_dimensions << name
+          end
+        end
+      end
+      @dimensions = all_dimensions
+    end
+
+    def get_dimension_names
+      dimensions = list_dimensions['body']['dimensions']
+      dimensions ? dimensions.map { |d| d['name']} : []
+    end
   end
 end

data/lib/analytics-psw/event_types.rb

@@ -2,21 +2,37 @@ module AnalyticsPSW
   module EventTypes
 
     def create_event_type(name, description = "")
-      metadata = create_metadata({:name => name.to_s, :description => description})
-      resp = post_json("#{@service_location}/event_types", "event_type", metadata)
+      body = create_json_body('event_type', {:name => name.to_s, :description => description})
+      resp = http_request(:post, "#{@service_location}/event_types", nil, body)
       @event_types |= [name.to_s] if resp.status && [200, 201, 202].include?(resp.status)
       parse_json_response(resp)
     end
 
     def list_event_types
-      resp = get_json("#{@service_location}/event_types")
+      resp = http_request(:get, "#{@service_location}/event_types")
       parse_json_response(resp)
     end
 
     def show_event_type(event_name)
-      resp = get_json("#{@service_location}/event_types/#{event_name.to_s}")
+      resp = http_request(:get, "#{@service_location}/event_types/#{event_name.to_s}")
       parse_json_response(resp)
     end
 
+    private
+
+    def find_or_create_event_types
+      all_event_types = get_event_names
+      new_events = @event_types - all_event_types
+      new_events.each do |event_type|
+        create_event_type(event_type)
+      end
+      @event_types |= all_event_types
+    end
+
+    def get_event_names
+      event_types = list_event_types['body']['event_types']
+      event_types ? event_types.map{|e| e['name']} : []
+    end
+
   end
 end

data/lib/analytics-psw/events.rb

@@ -5,7 +5,8 @@ module AnalyticsPSW
       return invalid_event_type_response unless event_type_exists? event_type
       return invalid_metadata_response unless dimensions_exist? metadata
       metadata[:event_type] = event_type.to_s
-      parse_json_response(post_json("#{@service_location}/events", 'event', metadata))
+      body = create_json_body('event', metadata)
+      parse_json_response(http_request(:post, "#{@service_location}/events", nil, body))
     end
 
   private

data/lib/analytics-psw/reports.rb

@@ -5,7 +5,7 @@ module AnalyticsPSW
   module Reports
 
     def query_analytics(query_parameters)
-      raw_report = get_json("#{@service_location}/reports/query.json", query_parameters)
+      raw_report = http_request(:get, "#{@service_location}/reports/query.json", query_parameters)
       parsed_report = parse_json_response(raw_report)
       create_analytics_report(parsed_report)
     end
@@ -20,28 +20,29 @@ module AnalyticsPSW
 
     def create_report(name, query_parameters)
       query_parameters[:name] = name.to_s
-      resp = post_json("#{@service_location}/reports", 'report', query_parameters )
+      body = create_json_body('report', query_parameters)
+      resp = http_request(:post, "#{@service_location}/reports", nil, body)
       parse_json_response(resp)
     end
 
     def list_reports
-      resp = get_json("#{@service_location}/reports")
+      resp = http_request(:get, "#{@service_location}/reports")
       parse_json_response(resp)
     end
 
     def report_criteria(report_name)
-      resp = get_json("#{@service_location}/reports/#{report_name.to_s}/criteria")
+      resp = http_request(:get, "#{@service_location}/reports/#{report_name}/criteria")
       parse_json_response(resp)
     end
 
     def run_report(report_name, where_criteria = {})
-      raw_report = get_json("#{@service_location}/reports/#{report_name.to_s}/results", where_criteria)
+      raw_report = http_request(:get, "#{@service_location}/reports/#{report_name}/results", where_criteria)
       parsed_report = parse_json_response(raw_report)
       create_analytics_report(parsed_report)
     end
 
     def delete_report(report_name)
-      resp = delete_resource("#{@service_location}/reports/#{report_name.to_s}")
+      resp = http_request(:delete, "#{@service_location}/reports/#{report_name}")
       parse_json_response(resp)
     end
 

data/lib/analytics-psw/services.rb

@@ -1,12 +1,12 @@
 module AnalyticsPSW
   module Services
     def show_service_resources(service_name)
-      resp = get_json("/services/#{service_name.to_s}")
+      resp = http_request(:get, "/services/#{service_name.to_s}")
       parse_json_response(resp)
     end
 
     def show_service_metadata(service_name)
-      resp = get_json("/services/#{service_name.to_s}/metadata")
+      resp = http_request(:get, "/services/#{service_name.to_s}/metadata")
       parse_json_response(resp)
     end
   end

data/lib/analytics-psw/utilities.rb

@@ -0,0 +1,85 @@
+module AnalyticsPSW
+  module Utilities
+    private
+
+    def update_token
+      url = "#{@server_url}/oauth/token?client_id=#{@client_id}&client_secret=#{@client_secret}"
+      raw = http_request(:post, url)
+      resp = parse_json_response(raw)
+      @token = resp['body']['access_token']
+    end
+
+    def faraday_connection
+      @proxy ? Faraday.new(@server_url, {proxy: {uri: @proxy}}) : Faraday.new(@server_url)
+    end
+
+    def http_request(http_method, url, params = nil, body = nil)
+      json_block  = ->(req) do
+        req.url url
+        req.headers['Content-Type'] = 'application/json'
+        req.headers['Authorization']= "Bearer #{@token}" if @token
+        req.params = params if params
+        req.body = body if body
+      end
+      @conn.send(http_method, &json_block)
+    end
+
+    def multi_get_json(service_location, query_parameters)
+      results = []
+      EventMachine.run do
+        multi = EventMachine::MultiRequest.new
+        connection_opts = {}
+        connection_opts = {proxy: {host: @proxy.sub(/^https?\:\/\//, ''), port: 80}} if @proxy.present?
+        query_parameters.each_with_index do |param, idx|
+          http = EventMachine::HttpRequest.new(service_location, connection_opts)
+          req = http.get query: param, head: {'Authorization' => "Bearer #{@token}"}
+          multi.add idx, req
+        end
+        multi.callback do
+          response = multi.responses[:callback]
+          error =  multi.responses[:errback]
+          EventMachine.stop
+          (0..query_parameters.size-1).each do |idx|
+            results += [multi_parse_json_response(response[idx])] if response[idx].present?
+            results += [multi_parse_json_response(error[idx])] if error[idx].present?
+          end
+        end
+      end
+      results
+    end
+
+    def create_json_body(type, metadata = {})
+      {type => metadata.reject { |k,v| v == '' }}.to_json
+    end
+
+    def parse_json_response(json_response)
+      parsed_response = {}
+      parsed_response['status'] = json_response.status if json_response.status.present?
+
+      if [200, 201, 202].include?(json_response.status)
+        parsed_response['body'] = JSON.parse(json_response.body) if json_response.body.present?
+        parsed_response['location'] = json_response.headers['location'] if json_response.headers.present? && json_response.headers['location']
+      else
+        parsed_response['body'] = {}
+        parsed_response['error_message'] = json_response.body
+      end
+
+      parsed_response
+    end
+
+    def multi_parse_json_response(response)
+      parsed_response = {}
+      parsed_response['status'] = response.response_header.present? ? response.response_header.status : 500
+
+      if [200, 201, 202].include?(parsed_response['status'])
+        parsed_response['body'] = JSON.parse response.response if response.response.present?
+        parsed_response['location'] = response.headers.location if response.headers.present? && response.headers.location.present?
+      else
+        parsed_response['body'] = {}
+        parsed_response['error_message'] = response.error if response.error.present?
+      end
+      parsed_response
+    end
+
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: analytics-psw
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.3.3
 platform: ruby
 authors:
 - Lexmark International Technology S.A
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-12 00:00:00.000000000 Z
+date: 2014-08-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -154,6 +154,7 @@ files:
 - lib/analytics-psw/events.rb
 - lib/analytics-psw/reports.rb
 - lib/analytics-psw/services.rb
+- lib/analytics-psw/utilities.rb
 - lib/analytics_report.rb
 - lib/analytics_report_field.rb
 homepage: