mode-sdk 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a2fe9f487c0cc04dd360dd4e4439a6d7a9876d95
+  data.tar.gz: 1d23400061905abb0ecec7a45831e3b39f89a5d6
+SHA512:
+  metadata.gz: 054cd8e9d9f0c36963b85c7678812d8b60e8baadd8de87e4ccf75b4b5b928e720ea3276ecb1632b3278779852615ef1bf1dbc26035b367310f11604888e02914
+  data.tar.gz: 2f6481aef7a2385992b57841016d8adab0bf5175f8c786325a2b5977a844ff787121a311d1bc329ac5a5d01f8f7b27e3aa80c56ca4475de09c02011e2061c252

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/.yardopts

@@ -0,0 +1 @@
+--markup=markdown

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Mode Analytics
+
+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,109 @@
+# Mode Ruby SDK
+
+[![Code Climate](https://codeclimate.com/repos/53ea7f57e30ba007c500a24a/badges/44f08215be76ea780d56/gpa.svg)](https://codeclimate.com/repos/53ea7f57e30ba007c500a24a/feed)
+
+This SDK provides a wrapper for the [Mode Analytics](https://modeanalytics.com)
+API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'mode-sdk'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mode-sdk
+
+## Usage
+
+### Setup
+
+```ruby
+Mode::Sdk.configure do |config|
+  config.token  = 'token'
+  config.secret = 'secret'
+end
+```
+
+You can manage your Mode API tokens here:
+[https://modeanalytics.com/settings/access_tokens]
+(https://modeanalytics.com/settings/access_tokens)
+
+### 1. Upload CSV to Mode
+
+Before importing a table, you will need to upload the raw CSV (with no header)
+using the `Upload` class. The first argument can be either a string or an
+IO-like object.
+
+```ruby
+csv = File.open('sf_film_locations.csv', 'r') { |f| f.read }
+
+upload = Mode::Sdk::Upload.new(csv)
+upload.create
+upload.token # => '5b68f4b6a3c6' save this token for step 2
+```
+
+Full Upload API documentation:
+[http://developer.modeanalytics.com/#page:uploads,header:uploads-upload]
+(http://developer.modeanalytics.com/#page:uploads,header:uploads-upload)
+
+### 2. Import the table
+
+Next, initialize a `Table` instance with a name:
+
+```ruby
+table = Mode::Sdk::Table.new('sf_film_locations')
+table.exists? # => true, false
+```
+
+Assign a column schema (required) and description (optional):
+
+```ruby
+table.columns = [
+  { name: 'movie_title',  type: 'string' },
+  { name: 'release_year', type: 'integer' },
+  { name: 'location',     type: 'string' }
+]
+
+table.description = 'Famous film locations in San Francisco'
+```
+
+Then use the upload token from Step 1 to create or replace the table:
+
+```ruby
+table.upload_token = '5b68f4b6a3c6'
+
+table.create
+table.replace
+```
+
+### 3. Check the status of your import
+
+The response from `Table#create` or `Table#replace` will indicate the status of
+your import, including:
+
+* `enqueued`
+* `running`
+* `succeeded`
+* `failed`
+
+You can poll this response until your import has completed.
+
+## Examples
+
+A collection of examples can be found in the
+[mode/mode-ruby-examples](https://github.com/mode/mode-ruby-examples)
+repository.
+
+## 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,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/mode/sdk.rb

@@ -0,0 +1,70 @@
+# encoding: utf-8
+#
+# Mode Analytics namespace
+#
+module Mode
+  # Official [Mode Analytics](https://modeanalytics.com) Ruby SDK
+  #
+  module Sdk
+    class << self
+      # Set Mode configuration values
+      #
+      # @yield [Mode::Sdk::Configuration] the configuration instance
+      #
+      # @example
+      #   Mode.configure do |config|
+      #     config.token  = "token"
+      #     config.secret = "secret"
+      #   end
+      #
+      def configure
+        yield config
+      end
+
+      # The Mode configuration instance
+      #
+      # @return [Mode::Sdk::Configuration] the configuration instance
+      #
+      def config
+        @config ||= Mode::Sdk::Configuration.new
+      end
+
+      # The Mode API representation of the authenticated account
+      #
+      # @return [Hash] the account representation
+      #
+      def account
+        @account ||= Mode::Sdk::Client.account
+      end
+
+      # The username of the authenticated account
+      #
+      # @return [String] the username
+      #
+      def username
+        account.fetch('username')
+      end
+
+      # Un-memoize everything
+      #
+      def reset
+        %w(config account).each do |name|
+          next unless instance_variable_defined?(:"@#{name}")
+
+          remove_instance_variable(:"@#{name}")
+        end
+      end
+    end
+  end
+end
+
+require 'mode/sdk/client'
+require 'mode/sdk/column'
+require 'mode/sdk/column_set'
+require 'mode/sdk/configuration'
+require 'mode/sdk/hash_util'
+require 'mode/sdk/table'
+require 'mode/sdk/table_import'
+require 'mode/sdk/upload'
+require 'mode/sdk/version'
+require 'mode/sdk/warehouse_util'

data/lib/mode/sdk/client.rb

@@ -0,0 +1,87 @@
+# encoding: utf-8
+#
+require 'cgi'
+require 'net/http'
+require 'uri'
+
+module Mode
+  module Sdk
+    # The Client class provides an interface for common Mode API requests
+    #
+    class Client
+      class << self
+        # Make an HTTP HEAD request with the Mode API
+        #
+        # @param path [String] the request path
+        # @param options [optional, Hash] hash of
+        #   {Mode::Sdk::Client::Request#initialize request options}
+        #
+        # @return [Mode::Sdk::Client::Response] the response
+        #
+        def head(path, options = {})
+          request(Net::HTTP::Head.new(path), nil, options)
+        end
+
+        # Make an HTTP GET request with the Mode API
+        #
+        # @param path [String] the request path
+        # @param options [optional, Hash] hash of
+        #   {Mode::Sdk::Client::Request#initialize request options}
+        #
+        # @return [Mode::Sdk::Client::Response] the response
+        #
+        def get(path, options = {})
+          request(Net::HTTP::Get.new(path), nil, options)
+        end
+
+        # Make an HTTP POST request with the Mode API
+        #
+        # The body param may be either:
+        #
+        # * a String containing raw CSV, or
+        # * an IO-like object containing the raw CSV for streaming requests
+        #
+        # @param path [String] the request path
+        # @param body [String, #read] the request body
+        # @param options [optional, Hash] hash of
+        #   {Mode::Sdk::Client::Request#initialize request options}
+        #
+        # @return [Mode::Sdk::Client::Response] the response
+        #
+        def post(path, body, options = {})
+          request(Net::HTTP::Post.new(path), body, options)
+        end
+
+        # Make an HTTP PUT request with the Mode API
+        #
+        # @param path [String] the request path
+        # @param body [String, #read] the request body
+        # @param options [optional, Hash] hash of
+        #   {Mode::Sdk::Client::Request#initialize request options}
+        #
+        # @return [Mode::Sdk::Client::Response] the response
+        #
+        def put(path, body, options = {})
+          request(Net::HTTP::Put.new(path), body, options)
+        end
+
+        # Get the Mode API representation of the authenticated account
+        #
+        # @return [Mode::Sdk::Client::Response] the response
+        #
+        def account
+          get('/api/account', expect: [200]).body
+        end
+
+        private
+
+        def request(request, body, options = {})
+          Mode::Sdk::Client::Request.new(request, body, options).response
+        end
+      end
+    end
+  end
+end
+
+require 'mode/sdk/client/request'
+require 'mode/sdk/client/response'

data/lib/mode/sdk/client/request.rb

@@ -0,0 +1,133 @@
+# encoding: utf-8
+#
+require 'mode/sdk/version'
+
+module Mode
+  module Sdk
+    class Client
+      # The Request class wraps a Net::HTTPRequest object for the Mode API
+      #
+      class Request
+        # Construct a new Request instance
+        #
+        # @param http_request [Net::HTTPRequest] the http request
+        # @param body [String, #read] the request body
+        # @param options [optional, Hash] hash of options
+        #
+        # @option options [Array<Integer>] :expect an array of expected
+        #   response codes
+        # @option options [String] :content_type the content type of the
+        #   request
+        # @option options [Integer] :content_length the content length of the
+        #   request
+        #
+        # @return [Mode::Sdk::Client::Request] the instance
+        #
+        def initialize(http_request, body = nil, options = {})
+          @http_request = http_request
+          @body         = body
+          @options      = options
+        end
+
+        # Result of the HTTP request
+        #
+        # @return [Mode::Sdk::Client::Response] the response
+        #
+        def response
+          http_response = self.class.http.request(build_http_request)
+
+          response = Mode::Sdk::Client::Response.new(
+            http_response, expected_codes)
+
+          response.tap(&:validate!)
+        end
+
+        private
+
+        DEFAULT_HOST         = 'https://modeanalytics.com'
+        DEFAULT_CONTENT_TYPE = 'application/json'
+        USER_AGENT           = "mode-sdk/#{Mode::Sdk::VERSION}"
+
+        attr_reader :http_request, :body, :options
+
+        def build_http_request
+          http_request.tap do
+            assign_basic_auth
+            assign_headers
+            assign_content_meta
+            assign_body
+          end
+        end
+
+        def assign_basic_auth
+          http_request.basic_auth(*basic_auth)
+        end
+
+        def assign_headers
+          http_request['accept']     = DEFAULT_CONTENT_TYPE
+          http_request['user-agent'] = USER_AGENT
+        end
+
+        def assign_content_meta
+          http_request.content_type   = content_type
+          http_request.content_length = content_length if content_length
+        end
+
+        def assign_body
+          case body
+          when nil
+            # no-op
+          when String
+            http_request.body = body
+          else
+            http_request.body_stream = body
+          end
+        end
+
+        def expected_codes
+          options.fetch(:expect, [])
+        end
+
+        def content_type
+          options.fetch(:content_type, DEFAULT_CONTENT_TYPE)
+        end
+
+        def content_length
+          options.fetch(:content_length, nil)
+        end
+
+        def basic_auth
+          [Mode::Sdk.config.token, Mode::Sdk.config.secret]
+        end
+
+        class << self
+          # The Net::HTTP instance used to make requests
+          #
+          # @return [Net::HTTP] the HTTP instance
+          #
+          def http
+            return @http if defined?(@http)
+
+            @http = Net::HTTP.new(uri.host, uri.port)
+            @http.use_ssl = host =~ /\Ahttps/
+            @http
+          end
+
+          # The Mode API host to use for requests
+          #
+          # @return [String] the API host
+          #
+          def host
+            ENV['MODE_HOST'] || Mode::Sdk.config.host || DEFAULT_HOST
+          end
+
+          private
+
+          def uri
+            @uri ||= URI(host)
+          end
+        end
+      end
+    end
+  end
+end