grepdata_client 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in grepdata_client.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Dustin Chang
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,29 @@
+# GrepdataClient
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'grepdata_client'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install grepdata_client
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/grepdata_client.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'grepdata_client/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "grepdata_client"
+  spec.version       = GrepdataClient::VERSION
+  spec.authors       = ["Dustin Chang"]
+  spec.email         = ["dustin@grepdata.com"]
+  spec.description   = %q{Ruby client to query Grepdata API}
+  spec.summary       = %q{Ruby client to query Grepdata API}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "typhoeus",'~> 0.6.3'
+  spec.add_dependency "json", '~> 1.8' if RUBY_VERSION < '1.9'
+  
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/lib/grepdata_client/query.rb

@@ -0,0 +1,20 @@
+module GrepdataClient
+  class DataRequest
+    attr_reader :request, :url, :params, :headers, :action
+    
+    def initialize(action, options)
+      @action = action.to_s
+      @url = "#{options[:url]}/#{@action}"
+      @params = options[:params] || {}
+      @headers = options[:headers] || {}
+      
+      params = Utils.format_params @action, @params
+
+      @request = ::Typhoeus::Request.new(@url, params: params, headers: @headers)
+    end
+    
+    def get_result
+      return @request.response.body
+    end
+  end
+end

data/lib/grepdata_client/utils.rb

@@ -0,0 +1,70 @@
+module GrepdataClient
+  module Utils
+    def self.date_format
+      "%Y%m%d%H%M"
+    end
+    
+    def self.default_expiration
+      (Time.now.utc + (24*60*60)).strftime Utils.date_format
+    end
+    
+    def self.generate_key(api_key, options)
+      identity = "#{options[:datamart]}\n"
+      identity += "#{options[:values]}\n" if options[:values].length > 0
+      identity += options[:expiration]
+      
+      #hash identity using HMAC-SHA1.  return as base64 encoded string
+      Base64.encode64(OpenSSL::HMAC.digest('sha1', api_key, identity)).chomp
+    end
+  
+    def self.check_attributes(name, options)
+      params  = options[:params]
+      required = options[:required]
+      
+      missing = []
+      required.each_key do |key|
+        if not params[key].is_a? required[key]
+          message = "#{name} missing required attribute #{key.to_s} of type #{required[key].name}"
+          missing.push message
+          puts "Warning: #{message}"
+        end
+      end
+      raise "Error: #{name} missing required attributes" if missing.length > 0
+    end
+    
+    def self.preprocess_dates(params, attributes)
+      attributes.each do |attr|
+        date = DateTime.parse params[attr]
+        params[attr] = date.strftime Utils.date_format
+      end
+    end
+    
+    def self.format_params(action, params)
+      result = {}
+      result[:endpoint] = params[:endpoint] if params[:endpoint]
+      result[:datamart] = params[:datamart] if params[:datamart]
+      result[:metrics] = params[:metrics].join(',') if params[:metrics]
+      result[:dimensions] = params[:dimensions].join(',') if params[:dimensions]
+      result[:filters] = params[:filters].to_json if params[:filters]
+      result[:time_interval] = params[:time_interval] if params[:time_interval]
+    
+      if action == "funneling"
+        steps = []
+        params[:steps].each do |step|
+          step[:start_date] = params[:start_date]
+          step[:end_date] = params[:end_date]
+          steps.push step
+        end
+        result[:steps] = { :steps => steps }.to_json
+        result[:funnel_dimension] = params[:funnel_dimension]
+      else
+        result[:start_date] = params[:start_date]
+        result[:end_date] = params[:end_date]
+      end
+    
+      result[:api_key] = params[:api_key] if params[:api_key]
+      result[:token] = params[:token] if params[:token]
+      result
+    end
+  end
+end

data/lib/grepdata_client/version.rb

@@ -0,0 +1,3 @@
+module GrepdataClient
+  VERSION = "0.0.1"
+end

data/lib/grepdata_client.rb

@@ -0,0 +1,179 @@
+require "typhoeus"
+require 'base64'
+require 'openssl'
+require 'json'
+require 'Date'
+
+require "grepdata_client/version"
+require "grepdata_client/query"
+require "grepdata_client/utils"
+
+module GrepdataClient
+  class Client
+  
+    attr_accessor :api_url, :api_key, :token, :parallel, :parallel_manager
+    
+    CONFIG = {
+      :api_url => "https://api.grepdata.com/v1",
+    }
+    
+    def initialize(config)
+      @api_key, @token = config.values_at(:api_key, :token) 
+      @api_url = config[:api_url] || CONFIG[:api_url]
+      @parallel = config[:parallel] || false
+      if config[:parallel_manager]
+        @parallel_manager = config[:parallel_manager] 
+      end
+    end
+
+    def query(params)
+      params[:api_key] = params[:api_key] || @api_key
+      params[:filters] = params[:filters] || {}
+      
+      Utils.preprocess_dates params, [:start_date, :end_date]
+      
+      Utils.check_attributes "params", 
+        params: params,
+        required: {
+          api_key: String, 
+          datamart: String,
+          dimensions: Array,
+          metrics: Array,
+          filters: Hash,
+          time_interval: String,
+          start_date: String,
+          end_date: String
+        }
+        
+      request(__method__, params: params)
+    end
+    
+    def funneling(params)
+      params[:api_key] = params[:api_key] || @api_key
+      params[:filters] = params[:filters] || {}
+      params[:only_totals] = params[:only_totals] || false
+      
+      Utils.preprocess_dates params, [:start_date, :end_date]
+      
+      Utils.check_attributes "params",
+        params: params,
+        required: {
+          api_key: String, 
+          datamart: String,
+          funnel_dimension: String,
+          dimensions: Array,
+          metrics: Array,
+          filters: Hash,
+          time_interval: String,
+          start_date: String,
+          end_date: String,
+          steps: Array
+        }  
+      
+      request(__method__, params: params)
+    end
+    
+    def dimensions(params)
+      params[:api_key] = params[:api_key] || @api_key
+      
+      Utils.check_attributes "params",
+        params: params,
+        required: { 
+          api_key: String, 
+          endpoint: String
+        }
+              
+      request(__method__, params: params)
+    end
+    
+    def query_with_token(params, access_key)
+      params[:token] = params[:token] || @token
+      params[:filters] = params[:filters] || {}
+      
+      Utils.preprocess_dates params, [:start_date, :end_date]
+      Utils.preprocess_dates access_key, [:expiration]
+      
+      Utils.check_attributes "params", 
+        params: params,
+        required: {
+          token: String, 
+          datamart: String,
+          dimensions: Array,
+          metrics: Array,
+          filters: Hash,
+          time_interval: String,
+          start_date: String,
+          end_date: String
+        }
+      
+      Utils.check_attributes "access_key",
+        params: access_key,
+        required: { 
+          signature: String, 
+          restricted: String,
+          expiration: String
+        }
+      
+      request('fetch', params: params, headers: access_key)
+    end
+    
+    def run_requests
+      @parallel_manager.run if @parallel_manager
+    end
+            
+    def request(action, options)      
+      query = GrepdataClient::DataRequest.new action, 
+                url: @api_url, 
+                params: options[:params], 
+                headers: options[:headers]
+      
+      if @parallel
+        unless @parallel_manager
+          @parallel_manager = ::Typhoeus::Hydra.new 
+        end
+        @parallel_manager.queue query.request
+      else
+        query.request.run
+      end
+      
+      return query
+    end
+    
+    def generate_access_key(api_key, options)
+      restricted = options[:restricted] || []
+      expiration = options[:expiration] || Utils.default_expiration
+      
+      params = options[:params] || options[:request].params
+      params = Utils.format_params 'query', params
+      
+      datamart = params[:datamart]
+      
+      values = ""
+      restricted.each do |param|
+        value = params
+        segments = param.split(".")
+        segments.each do |segment|
+          value = JSON.parse value if value.is_a? String
+          value = value[segment.to_sym] || value[segment]
+        end
+        value = segments.length > 1? value.to_json : value.to_s
+        values += "&" if values.length > 0
+        values += "#{param}=#{value}"
+      end
+
+      scope = "datamart=#{datamart}"
+      scope += "&#{values}" if 
+      signature = Utils.generate_key(api_key, 
+        datamart: datamart, 
+        values: values,
+        expiration: expiration)
+  
+      return {
+        :signature => signature,
+        :restricted => restricted.join(','),
+        :expiration => expiration.to_s,
+        :scope => scope
+      }
+    end
+  end
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: grepdata_client
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Dustin Chang
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.3
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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'
+description: Ruby client to query Grepdata API
+email:
+- dustin@grepdata.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- grepdata_client.gemspec
+- lib/grepdata_client.rb
+- lib/grepdata_client/query.rb
+- lib/grepdata_client/utils.rb
+- lib/grepdata_client/version.rb
+homepage: ''
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Ruby client to query Grepdata API
+test_files: []