soothsayer 0.0.1 → 0.0.2

data/README.markdown

@@ -1,2 +1,30 @@
 # Soothsayer
-Soothsayer is an easy Ruby client for Google's Prediction API. It is still very alpha and a proper README will be forthcoming.
+Soothsayer is a thin Ruby wrapper around Google's Prediction API.
+
+## Setup
+Go to [Google's API Console](http://code.google.com/apis/console). Sign up and turn on both the "Google Cloud Storage" and "Prediction API" services. Before you can use the Prediction API, you'll have to turn on billing.
+
+Go to "API Access" section of the Google API Console and create an "Authorized API Access" key, "Client ID for installed applications." You'll need the "Client ID" and "Client secret."
+
+Download Google's Ruby API client gem:
+    gem install google-api-client
+
+Now you need to download your OAuth keys
+    google-api oauth-2-login --scope=https://www.googleapis.com/auth/prediction --client-id=<< YOUR CLIENT ID >> --client-secret=<< YOUR CLIENT SECRET >>
+
+This will create a file at <code>~/.google-api.yaml</code> which contains your OAuth keys. Move this file into your project and use it to configure Soothsayer:
+    config_file = File.expand_path('path/to/google-api.yaml')
+    config = open(config_file, 'r'){ |file| YAML.load(file.read) }
+    Soothsayer.config do |c|
+      c.client_id = config.client_id
+      c.client_secret = config.client_secret
+      c.access_token = config.access_token
+      c.refresh_token = config.refresh_token
+    end
+
+## Usage
+To use Soothsayer, refer to [Google's documentation](https://developers.google.com/prediction/docs/reference/v1.5/reference).
+
+    Soothsayer::HostedModel.predict("sample.languageid", {:input => {:csvInstance => ["Como se llama?"]}})
+    Soothsayer::TrainedModel.list
+    Soothsayer::TrainedModel.update("my.trained.model.name", {:label => "my_label", :csvInstance => [col1, col2, col3]})

data/lib/soothsayer/version.rb

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

data/lib/soothsayer.rb

@@ -6,6 +6,30 @@ require 'google/api_client'
 require 'multi_json'
 
 module Soothsayer
+  def self.credentials
+    @@config
+  end
+
+  # Configures Soothsayer with the credentials downloaded by the Ruby api client into .google-api.yaml
+  #
+  #   config_file = File.expand_path('~/.google-api.yaml')
+  #   config = open(config_file, 'r'){ |file| YAML.load(file.read) }
+  #   Soothsayer.config do |c|
+  #     c.client_id = config.client_id
+  #     c.client_secret = config.client_secret
+  #     c.access_token = config.access_token
+  #     c.refresh_token = config.refresh_token
+  #   end
+  #
+  def self.config(config = Configuration.new)
+    yield config
+    @@config = config
+  end
+
+  class Configuration
+    attr_accessor :client_id, :client_secret, :access_token, :refresh_token
+  end
+
   class OAuthTokenError < StandardError; end
   class API
     include HTTParty
@@ -26,15 +50,14 @@ module Soothsayer
       end
 
       def create_client
-        config_file = File.expand_path('~/.google-api.yaml')
-        config = open(config_file, 'r'){ |file| YAML.load(file.read) }
+        raise OAuthTokenError, 'Please configure Soothsayer first with Soothsayer.config.' if Soothsayer.credentials.nil?
         client = Google::APIClient.new(:authorization => :oauth_2)
         unless client.authorization.nil?
           client.authorization.scope = nil
-          client.authorization.client_id = config["client_id"]
-          client.authorization.client_secret = config["client_secret"]
-          client.authorization.access_token = config["access_token"]
-          client.authorization.refresh_token = config["refresh_token"]
+          client.authorization.client_id = Soothsayer.credentials.client_id
+          client.authorization.client_secret = Soothsayer.credentials.client_secret
+          client.authorization.access_token = Soothsayer.credentials.access_token
+          client.authorization.refresh_token = Soothsayer.credentials.refresh_token
           client.register_discovery_uri('discovery', 'v1.5', nil)
           self.api_client = client
         else

metadata

@@ -2,7 +2,7 @@
 name: soothsayer
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors: 
 - Marc Love