empire-client 0.3 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 528dc8d235093675e0f22b738a0f16d8e7134e09
-  data.tar.gz: c6b479ff28bef1e9f7ad0a9d219923b3e3a4078b
+  metadata.gz: 0f4fb9c86e7df8d24e6b73bee4f2daa7494dedca
+  data.tar.gz: 16ec7ecebb1b7be684c9e2605f037c3117f722c6
 SHA512:
-  metadata.gz: 0534ce3f0f14d9525eecbd921a7f6e9d1b51e378d6ffc39f5f67b0f841b1c376cb130116928a0ab41843c97da7aab69b2f69e080cce88502fca147029c2ff498
-  data.tar.gz: 5948cc3f5ee664f930b4586a9cd21231ffc2e1806a5c0e4ea084c8c2835c0792371493b574c1f750b65794960e719c5afa012261ec818fd7485990b21f689854
+  metadata.gz: 0a78109f1f14a5150ec7fec450dae4f26c04e88183166557a123f45e5466f411e3d1169747d61846ecfd2672df22cd27fa98cffdef11226e6e2667e3b1dda362
+  data.tar.gz: 2b2e51e26f9a9fc6836790967715e4cd7f9d8135918fa9321e837f56cdbc66f79a8556d2830f6a29c62d0816d35e123a62e5f081f108c8f4ecb1221f73ccb7c4

data/lib/empire.rb

@@ -6,6 +6,7 @@ require 'httpclient'
 require 'irb-pager'
 
 require_relative 'walkthrough.rb'
+require_relative 'exceptions.rb'
 
 class Empire
   attr_reader :base_url
@@ -13,13 +14,13 @@ class Empire
   # 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)
-  #    * :end_user => a string identifying the end user, required for any operations on views (default: nil)
+  #    * :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
-    @end_user = opts[:end_user]
+    @enduser = opts[:enduser]
     @session_key = nil
 
     @http_client = HTTPClient.new
@@ -27,9 +28,13 @@ class Empire
     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]
+      service_secrets = YAML.load_file opts[:secrets_yaml]
+
+      @secrets = {}
+      @service_secrets[service]['option'].each{|k, v| 
+        secrets[k] = v['value']
+      }
     end
   end
 
@@ -39,13 +44,7 @@ class Empire
   def connect(service, secrets = nil)
     path = "services/#{service}/connect"
     unless secrets
-      unless @service_secrets
-        raise "secrets must be provided on connect command, 
-          or secrets_yaml file must be given when constructing this instance"
-      end
-
-      secrets = {}
-      @service_secrets[service]['option'].each{|k, v| secrets[k] = v['value']}
+      raise Empire::MissingSecretsError.new
     end
     request path, :post, {}, secrets
   end
@@ -58,7 +57,7 @@ class Empire
     elsif service and !table
       path += "/#{service}"
     elsif !service and table
-      raise "Service must be specified if table is specified"
+      raise Empire::MissingServiceError.new("Service must be specified if table is specified")
     end
 
     request path
@@ -90,8 +89,8 @@ class Empire
 
   # Materialize a SQL query as a view. This creates or updates a view.
   def materialize_view(name, sql)
-    unless @end_user
-      raise "Cannot use materialized view within a session initiated without an enduser"
+    unless @enduser
+      raise Empire::MissingEnduserError.new
     end
     path = "view/#{name}"
     data = {'query' => sql}
@@ -100,8 +99,8 @@ class Empire
 
   # Delete a materialized view of SQL query
   def drop_view(name)
-    unless @end_user
-      raise "Cannot use materialized view within a session initiated without an enduser"
+    unless @enduser
+      raise Empire::MissingEnduserError.new
     end
     path = "view/#{name}"
     request path, :delete
@@ -116,7 +115,7 @@ class Empire
     when 'ready' then true
     when 'pending' then false
     else
-      raise "Unknown view status: #{response['viewStatus']}"
+      raise APIError.new("Unknown view status: #{response['viewStatus']}")
     end
   end
 
@@ -136,8 +135,8 @@ class Empire
   private
 
   def view_status(name)
-    unless @end_user
-      raise "Cannot use materialized view within a session initiated without an enduser"
+    unless @enduser
+      raise Empire::MissingEnduserError.new
     end
     path = "view/#{name}/status"
     request path, :get
@@ -152,8 +151,8 @@ class Empire
   def create_session
     headers = {'Authorization' => "Empire appkey=\"#{@app_key}\""}
     session_url = "session/create"
-    if @end_user
-      session_url = session_url + "?enduser=#{@end_user}"
+    if @enduser
+      session_url = session_url + "?enduser=#{@enduser}"
     end
     data = do_request session_url, :post, headers
     @sessionkey = data['sessionkey']
@@ -167,12 +166,20 @@ class Empire
       conn = @http_client.request_async method, url, nil, data.to_json, headers
       conn.pop.content
     else
-      # return the response body
+      # return the response body, parsed as JSON
+      
       response = @http_client.request method, url, body: data.to_json, header: headers
-      if response.status == HTTP::Status::INTERNAL
-        raise "Internal Server Error"
+
+      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.parse(response.body)
+      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

@@ -59,7 +59,7 @@ class Empire
       sql = "SELECT * FROM #{service}.#{table} LIMIT 5"
       puts "empire.query '#{sql}'"
       query(sql) do |row|
-        print_row(row, 75)
+        print_row(row)
       end
     rescue Exception => e
       puts "Problem with #{service}.#{table}"
@@ -77,21 +77,21 @@ class Empire
     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.1\nend"
+    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, 75)
+      print_row(row)
     end
 
     puts "empire.drop_view 'view_name'"
     drop_view 'view_name'
   end
 
-  def print_row(row, max_length)
+  def print_row(row, max_length = 70)
       fragment = row.slice(0, max_length)
       if fragment.length == max_length
         fragment = fragment + "..."

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: empire-client
 version: !ruby/object:Gem::Version
-  version: '0.3'
+  version: 0.3.1
 platform: ruby
 authors:
 - UPSHOT Data, Inc.
@@ -66,16 +66,17 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.18'
-description: Empire is an API for accessing enterprise SaaS services such as Salesforce,
-  Zendesk, Google Apps, etc. It 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.
+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: