empire 0.3.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ad55abf95507256a7620a5acff613f78606c5a62
+  data.tar.gz: 3a632ad359d69984f71aeae5ee9232f97504fe38
+SHA512:
+  metadata.gz: c9e9981bf7a3bebff5370dedb20216f6512ae0e9dab0caf8f066f56ee01a7fd72620929756e26cb8b5bd0c75fa5eca209d4b3a9a858835f78de9f137ad7c5f92
+  data.tar.gz: dac5a05b81926c2570b20de41f5588058bd59dcc8b7d561e68b3c22750e77024f397bbd7ca4ccb3ea3f659c2137948ba49c927c9cb9b0202abe7bb7d588d7a2f

data/lib/empire.rb

@@ -0,0 +1,190 @@
+require 'yaml'
+require 'json'
+require 'date'
+
+require 'httpclient'
+require 'irb-pager'
+
+require_relative 'walkthrough.rb'
+require_relative 'exceptions.rb'
+
+class Empire
+  attr_reader :base_url
+
+  # app_key is your Empire application key, and is necessary for using the API
+  # opts can include any of:
+  #    * :api_server => the server to connect to (default: api.empiredata.com)
+  #    * :enduser => a string identifying the end user, required for any operations on views (default: nil)
+  #    * :secrets_yaml => the path to a YAML file generated by https://login.empiredata.co (default: nil)
+  def initialize(app_key = nil, opts = {})
+    api_server = opts[:api_server] || 'api.empiredata.co'
+
+    @app_key = app_key
+    @enduser = opts[:enduser]
+    @session_key = nil
+
+    @http_client = HTTPClient.new
+
+    protocol = api_server.start_with?('localhost') ? 'http' : 'https'
+    @base_url = "#{protocol}://#{api_server}/empire/"
+
+    @service_secrets = nil
+    if opts[:secrets_yaml]
+      @service_secrets = YAML.load_file opts[:secrets_yaml]
+    end
+  end
+
+  # Connect to specific service
+  # service: service name
+  # secrets: hash with service secrets (optional if the Empire instance was initialized with a secrets_yaml)
+  def connect(service, secrets = nil)
+    path = "services/#{service}/connect"
+
+    unless secrets
+      unless @service_secrets
+        raise Empire::MissingSecretsError.new
+      end
+
+      secrets = {}
+      @service_secrets[service]['option'].each{|k, v| 
+        secrets[k] = v['value']
+      }
+    end
+
+    request path, :post, {}, secrets
+  end
+
+  # Describe all services, all tables within a given service, or a given table
+  def describe(service = nil, table = nil)
+    path = 'services'
+    if service and table
+      path += "/#{service}/#{table}"
+    elsif service and !table
+      path += "/#{service}"
+    elsif !service and table
+      raise Empire::MissingServiceError.new("Service must be specified if table is specified")
+    end
+
+    request path
+  end
+
+  # Paginated printing of an SQL query
+  def print_query(sql)
+    IRB::Pager.pager {
+      query(sql) do |l|
+        puts l
+      end
+    }
+  end
+
+  # Issue a SQL query, yielding each row
+  def query(sql)
+    path = 'query'
+    io = request path, :post, {}, {query: sql}, stream: true
+    io.each do |l|
+      yield l
+    end
+  end
+
+  # Insert a new row into this service table. The row should be a hash of {column: value}
+  def insert(service, table, row)
+    path = "services/#{service}/#{table}"
+    request path, :post, {}, row
+  end
+
+  # Materialize a SQL query as a view. This creates or updates a view.
+  def materialize_view(name, sql)
+    unless @enduser
+      raise Empire::MissingEnduserError.new
+    end
+    path = "view/#{name}"
+    data = {'query' => sql}
+    request path, :put, {}, data
+  end
+
+  # Delete a materialized view of SQL query
+  def drop_view(name)
+    unless @enduser
+      raise Empire::MissingEnduserError.new
+    end
+    path = "view/#{name}"
+    request path, :delete
+  end
+
+  # Boolean check if a materialized view is ready for querying.
+  # @note The user is expected to check view_ready? before querying a view with query()
+  def view_ready?(name)
+    status = view_status(name)
+
+    case status['viewStatus']
+    when 'ready' then true
+    when 'pending' then false
+    else
+      raise APIError.new("Unknown view status: #{response['viewStatus']}")
+    end
+  end
+
+  # Datetime that this view was materialized at.
+  # nil if the materialization is currently pending.
+  def view_materialized_at(name)
+    status = view_status(name)
+    Date.parse(status['materializedAt']) rescue nil
+  end
+
+  # emulate default Object#inspect method but only display the object_id, not the properties
+  # to make things cleaner and more similar to Python client
+  def inspect
+    "#<Empire:#{(object_id << 1).to_s(16)}>"
+  end
+
+  private
+
+  def view_status(name)
+    unless @enduser
+      raise Empire::MissingEnduserError.new
+    end
+    path = "view/#{name}/status"
+    request path, :get
+  end
+
+  def request(path, method = :get, headers = {}, data = {}, opts = {})
+    create_session unless @sessionkey
+    headers_with_session = headers.merge({'Authorization' => "Empire sessionkey=\"#{@sessionkey}\""})
+    do_request path, method, headers_with_session, data, opts
+  end
+
+  def create_session
+    headers = {'Authorization' => "Empire appkey=\"#{@app_key}\""}
+    session_url = "session/create"
+    if @enduser
+      session_url = session_url + "?enduser=#{@enduser}"
+    end
+    data = do_request session_url, :post, headers
+    @sessionkey = data['sessionkey']
+  end
+
+  def do_request(path, method = :get, headers = {}, data = {}, opts = {})
+    url = @base_url + path
+    headers.merge!({'Content-Type' => 'application/json', 'Accept' => '*/*'})
+    if opts[:stream]
+      # return an IO object representing the streamed content
+      conn = @http_client.request_async method, url, nil, data.to_json, headers
+      conn.pop.content
+    else
+      # return the response body, parsed as JSON
+      
+      response = @http_client.request method, url, body: data.to_json, header: headers
+
+      begin
+        json = JSON.parse(response.body)
+      rescue => e 
+        raise Empire::APIError.new("#{e} #{response.body}")
+      end
+
+      if json["status"] != "OK"
+        raise Empire::APIError.new(json["error"])
+      end
+      json
+    end
+  end
+end

data/lib/exceptions.rb

@@ -0,0 +1,22 @@
+
+class Empire
+  class APIError < RuntimeError; end
+
+  class MissingSecretsError < RuntimeError
+    def initialize(msg = "Secrets must be provided when connecting to a service, or a secrets YAML file must be given when constructing this instance")
+      super
+    end
+  end
+
+  class MissingEnduserError < RuntimeError
+    def initialize(msg = "Cannot use a materialized view within a session initiated without an enduser")
+      super
+    end
+  end
+
+  class MissingServiceError < RuntimeError
+    def initialize(msg = "Service must be specified")
+      super
+    end
+  end
+end

data/lib/walkthrough.rb

@@ -0,0 +1,101 @@
+
+class Empire
+  
+  # Run automatic test of all services from YAML
+  def walkthrough
+    @last_service = nil
+    @last_table = nil
+
+    unless @service_secrets
+      puts "Please connect some services in https://login.empiredata.co, and download the new yaml file"
+      return 
+    end
+
+    @service_secrets.each do |secret|
+      service = secret[0]
+      walkthrough_service(service)
+    end
+
+    walkthrough_materialized_view(@last_service, @last_table)
+
+    nil
+  end
+
+  private
+
+  def walkthrough_service(service)
+    puts "empire.connect '#{service}'"
+    begin
+      connect service
+    rescue
+      puts "Problem connecting to #{service}"
+      return
+    end
+
+    tables = describe service
+
+    unless tables and tables['service'] and tables['service']['tables']
+      puts "Can't find tables belonging to #{service}"
+      return
+    end
+
+    tables['service']['tables'].each do |table_data|
+      table = table_data['table']
+      walkthrough_table(service, table)
+    end
+
+    @last_service = service
+  end
+
+  def walkthrough_table(service, table)
+    if service == "mailchimp"
+      # These mailchimp tables can only be queried when filtering by a particular list.
+      if ["list_member", "campaign", "campaign_sent_to", "campaign_opened"].include? table
+        return
+      end
+    end
+
+    begin
+      sql = "SELECT * FROM #{service}.#{table} LIMIT 5"
+      puts "empire.query '#{sql}'"
+      query(sql) do |row|
+        print_row(row)
+      end
+    rescue Exception => e
+      puts "Problem with #{service}.#{table}"
+    end
+
+    @last_table = table
+  end
+
+  def walkthrough_materialized_view(service, table)
+    unless @enduser
+      puts "Please specify an enduser parameter when instantiating the client, so that you can try materialized views"
+      return
+    end
+
+    puts "empire.materialize_view('view_name', 'SELECT * FROM #{service}.#{table} LIMIT 5')"
+    materialize_view('view_name', "SELECT * FROM #{service}.#{table} LIMIT 5")
+
+    puts "until empire.view_ready? 'view_name'\n  sleep 0.01\nend"
+    until view_ready? 'view_name'
+      sleep 0.01
+    end
+
+    puts "empire.query 'SELECT * FROM view_name'"
+    query('SELECT * FROM view_name') do |row|
+      print_row(row)
+    end
+
+    puts "empire.drop_view 'view_name'"
+    drop_view 'view_name'
+  end
+
+  def print_row(row, max_length = 70)
+      fragment = row.slice(0, max_length)
+      if fragment.length == max_length
+        fragment = fragment + "..."
+      end
+      puts "   #{fragment}"
+    end
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: empire
+version: !ruby/object:Gem::Version
+  version: 0.3.3
+platform: ruby
+authors:
+- UPSHOT Data, Inc.
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httpclient
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.4'
+- !ruby/object:Gem::Dependency
+  name: irb-pager
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.18'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.18'
+description: Ruby client for the Empire API. Empire is an API for accessing enterprise
+  SaaS services such as Salesforce, Zendesk, Google Apps, etc. Empire provides a uniform,
+  database-like interface to every service that it supports. Empire makes it easy
+  to integrate data from multiple enterprise services into your own enterprise app.
+email: hello@empiredata.co
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/empire.rb
+- lib/exceptions.rb
+- lib/walkthrough.rb
+homepage: http://empiredata.co
+licenses:
+- Apache License, Version 2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Ruby client for the Empire API
+test_files: []