grepdata_client 0.0.1 → 0.0.2

data/README.md

@@ -1,29 +1,156 @@
 # GrepdataClient
 
-TODO: Write a gem description
+Official Ruby client for Grepdata API
 
 ## Installation
 
-Add this line to your application's Gemfile:
+    gem install grepdata_client
+
+or if you use a Gemfile:
 
     gem 'grepdata_client'
+    
+## Publishing Events
+
+    require 'rubygems'
+    require 'grepdata_client'
+
+    client = GrepdataClient::Client.new(token: "054a9c9ade7dcf325a3aab542ebd73b5", default_endpoint: 'demonstration')
+    client.track 'play', data: { age: 18 }
+
+## Querying Data 
+
+    require 'rubygems'
+    require 'grepdata_client'
+
+    client = GrepdataClient::Client.new(:api_key => "0ac15f3688987af763c67412066e3378")
+    
+    #Query
+    params =  { 
+      :datamart => "user_info",
+      :dimensions => %w(country),
+      :metrics => %w(Count),
+      :filters => { :country => %w(US) },
+      :time_interval => "h",
+      :start_date => "201306110800",
+      :end_date => "201306110900"
+    }
+    req = client.query params
+    puts req.get_result
+
+    #Funneling
+    params = { 
+      :datamart => 'demonstration',
+      :funnel_dimension => 'event',
+      :time_interval => 'd',
+      :dimensions => %w(event country),
+      :metrics => %w(Count),
+      :start_date => "201306120000",
+      :end_date => "201306190000",  
+      :steps => [
+        { :name => "step1: play", :value => "play" },
+        { :name => "step2: pause", :value => "pause" },
+        { :name => "step3: seek", :value => "seek" },
+        { :name => "step2: stop", :value => "stop" }
+      ],
+      :filters => { :country => %w(US) },
+      :only_totals => false
+    }
+    req = client.funneling params
+    puts req.get_result
+
+## Generating access key
+
+    require 'rubygems'
+    require 'grepdata_client'
+
+    client = GrepdataClient::Client.new(:api_key => "0ac15f3688987af763c67412066e3378")
+    
+    params =  { 
+      :datamart => "user_info",
+      :dimensions => %w(country),
+      :metrics => %w(Count),
+      :filters => { :country => %w(US) },
+      :time_interval => "h",
+      :start_date => "201306110800",
+      :end_date => "201306110900"
+    }
+    
+    access_key = client.generate_access_key api_key, 
+      params: params, 
+      restricted: ['dimensions', 'filters.country'],
+      expiration: '201306220100'
+      
+    puts access_key
+
+## Querying with access key
+
+    require 'rubygems'
+    require 'grepdata_client'
+
+    client = GrepdataClient::Client.new(:token => "054a9c9ade7dcf325a3aab542ebd73b5")
+    
+    #acquired via generate_access_key
+    access_key = {
+      :signature=>"0xBBKoaUe6RZSLM//6yqzbYelmI=", 
+      :restricted=>"dimensions,filters.country", 
+      :expiration=>"201306220100", 
+    }
+    
+    params =  { 
+      :datamart => "user_info",
+      :dimensions => %w(country),
+      :metrics => %w(Count),
+      :filters => { :country => %w(US) },
+      :time_interval => "h",
+      :start_date => "201306110800",
+      :end_date => "201306110900"
+    }
 
-And then execute:
+    req = client.query_with_token params, access_key
+    puts req.get_result
+    
+    #get url of the request
+    puts req.get_url
 
-    $ bundle
+## Running Request in Parallel
 
-Or install it yourself as:
+    require 'rubygems'
+    require 'grepdata_client'
 
-    $ gem install grepdata_client
+    #set parallel to true
+    client = GrepdataClient::Client.new(
+      :default_endpoint => 'demonstration', 
+      :token => "054a9c9ade7dcf325a3aab542ebd73b5",
+      :api_key => "0ac15f3688987af763c67412066e3378",
+      :parallel => true)
+    
+    # query or publish data.  Requests will be queued up
+    ...
+    
+    # execute the queued requests and run them in parallel
+    client.run_requests
+    
+We use Typhoeus to handle parallel requests.  You can also pass in your own hydra queue
 
-## Usage
+    require 'rubygems'
+    require 'grepdata_client'
 
-TODO: Write usage instructions here
+    #set parallel to true and pass in hydra queue
+    hydra = ::Typhoeus::Hydra.new
+    client = GrepdataClient::Client.new(
+      :default_endpoint => 'demonstration', 
+      :token => "054a9c9ade7dcf325a3aab542ebd73b5",
+      :api_key => "0ac15f3688987af763c67412066e3378",
+      :parallel => true,
+      :parallel_manager => hydra)
+      
+    # query or publish data.  Requests will be queued up
+    ...
+    
+    # this will execute the queued requests as well
+    hydra.run
 
-## Contributing
+## Copyright
 
-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
+Copyright (c) 2013+ Grepdata. See LICENSE for details.

data/lib/grepdata_client/query.rb

@@ -1,20 +1,24 @@
 module GrepdataClient
   class DataRequest
-    attr_reader :request, :url, :params, :headers, :action
+    attr_reader :request, :base_url, :params, :headers, :action
     
     def initialize(action, options)
       @action = action.to_s
-      @url = "#{options[:url]}/#{@action}"
+      @base_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)
+      @request = ::Typhoeus::Request.new(@base_url, params: params, headers: @headers)
     end
     
     def get_result
       return @request.response.body
     end
+    
+    def get_url
+      return @request.url
+    end
   end
 end

data/lib/grepdata_client/utils.rb

@@ -4,6 +4,10 @@ module GrepdataClient
       "%Y%m%d%H%M"
     end
     
+    def self.cache_buster
+      Time.now.getutc.to_i.to_s
+    end
+    
     def self.default_expiration
       (Time.now.utc + (24*60*60)).strftime Utils.date_format
     end
@@ -64,6 +68,10 @@ module GrepdataClient
     
       result[:api_key] = params[:api_key] if params[:api_key]
       result[:token] = params[:token] if params[:token]
+
+      result[:signature] = params[:signature] if params[:signature]
+      result[:restricted] = params[:restricted] if params[:restricted]
+      result[:expiration] = params[:expiration] if params[:expiration]
       result
     end
   end

data/lib/grepdata_client/version.rb

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

data/lib/grepdata_client.rb

@@ -11,20 +11,74 @@ require "grepdata_client/utils"
 module GrepdataClient
   class Client
   
-    attr_accessor :api_url, :api_key, :token, :parallel, :parallel_manager
+    attr_accessor :api_url, :api_key, :token, :send_with_headers,
+      :default_endpoint, :endpoint_map,
+      :parallel, :parallel_manager
     
     CONFIG = {
       :api_url => "https://api.grepdata.com/v1",
+      :beacon_url => "https://beacon.grepdata.com/v1"
     }
     
     def initialize(config)
-      @api_key, @token = config.values_at(:api_key, :token) 
+      @api_key, @token, @default_endpoint = 
+        config.values_at(:api_key, :token, :default_endpoint) 
+        
+      @send_with_headers = config[:send_with_headers] || false
+      @endpoint_map = config[:endpoint_map] || {}
       @api_url = config[:api_url] || CONFIG[:api_url]
+      @beacon_url = config[:beacon_url] || CONFIG[:beacon_url]
+      
       @parallel = config[:parallel] || false
+      
       if config[:parallel_manager]
         @parallel_manager = config[:parallel_manager] 
       end
     end
+    
+    def track(event, options)
+      token = options[:token] || @token
+      endpoint = @endpoint_map[event.to_sym] || @endpoint_map[event] || @default_endpoint
+      data = options[:data]
+      
+      Utils.check_attributes "Request", 
+        params: { token: token, endpoint: endpoint, data: data},
+        required: {
+          token: String,
+          endpoint: String,
+          data: Hash
+        }
+    
+      params = {
+        event: event,
+        q: data.to_json,
+        cb: Utils.cache_buster,
+        token: token
+      }
+      
+      params[:t] = options[:timestamp] if options[:timestamp]
+      params[:domain] = options[:domain] if options[:domain]
+      params[:ua] = options[:user_agent] if options[:user_agent]
+      params[:r] = options[:referer] if options[:referer]
+      params[:ip] = options[:ip] if options[:ip]
+      params[:visitor] = options[:visitor] if options[:visitor]
+      params[:session] = options[:session] if options[:session]
+      
+      url = "#{@beacon_url}/#{endpoint}"
+      
+      request = Typhoeus::Request.new url, params: params, timeout: 5
+      
+      if @parallel
+        unless @parallel_manager
+          @parallel_manager = ::Typhoeus::Hydra.new 
+        end
+        @parallel_manager.queue request
+      else
+        request.run
+      end
+      
+      request
+    end
 
     def query(params)
       params[:api_key] = params[:api_key] || @api_key
@@ -32,7 +86,7 @@ module GrepdataClient
       
       Utils.preprocess_dates params, [:start_date, :end_date]
       
-      Utils.check_attributes "params", 
+      Utils.check_attributes "Request", 
         params: params,
         required: {
           api_key: String, 
@@ -55,7 +109,7 @@ module GrepdataClient
       
       Utils.preprocess_dates params, [:start_date, :end_date]
       
-      Utils.check_attributes "params",
+      Utils.check_attributes "Request",
         params: params,
         required: {
           api_key: String, 
@@ -76,7 +130,7 @@ module GrepdataClient
     def dimensions(params)
       params[:api_key] = params[:api_key] || @api_key
       
-      Utils.check_attributes "params",
+      Utils.check_attributes "Request",
         params: params,
         required: { 
           api_key: String, 
@@ -93,7 +147,7 @@ module GrepdataClient
       Utils.preprocess_dates params, [:start_date, :end_date]
       Utils.preprocess_dates access_key, [:expiration]
       
-      Utils.check_attributes "params", 
+      Utils.check_attributes "Request", 
         params: params,
         required: {
           token: String, 
@@ -113,8 +167,17 @@ module GrepdataClient
           restricted: String,
           expiration: String
         }
+    
+      headers = {}  
+      if @send_with_headers
+        headers = access_key
+      else
+        params[:signature] = access_key[:signature]
+        params[:restricted] = access_key[:restricted]
+        params[:expiration] = access_key[:expiration]
+      end
       
-      request('fetch', params: params, headers: access_key)
+      request('fetch', params: params, headers: headers)
     end
     
     def run_requests

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: grepdata_client
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors: