turbot-api 0.0.16 → 0.0.17

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    N2Y4YTk5MDAwZGE4MDQxNjE1NzI2NDVhMWVjY2UxZDRmYTdkNTc3MA==
-  data.tar.gz: !binary |-
-    NjVhNGUxNDJiZTJkZWY3Y2RlNGMzYjY0YTQzMmIzMTliNTk0OWUyNw==
+SHA1:
+  metadata.gz: f67fab8e48984f6105b1ba156021609ae79097bb
+  data.tar.gz: 75013c5a69f091e9340b09c10a3144bb20607c5a
 SHA512:
-  metadata.gz: !binary |-
-    Yjk1NjkwM2ZmNTQxODA0MjkzNWU0ZWU0NTg3ZGY4ZDZlNmRmYzdlNzE0NDFj
-    YjUzZDQ2NzgwYWU0YzQ3ZGEyMDEzYmRiM2ViMzNjNGYzNjk3OWVjMDVhNmJh
-    YThiM2Y1MzJjYTI2ODEwYjFkMzYwNDVjNWQ2NGM5MDc3ZDE2YTk=
-  data.tar.gz: !binary |-
-    MGQxYjI0MGZkNDBlYmFlYTZlODdiYTJkOTdlYTdiNDgyOWRhZGQwMTEwMTk2
-    MmUwZDJmZGExZGE5NGIxMjhlNjVjZDQ3MDg3N2U0NTljM2Q4M2Q4NDRmNTE4
-    NmY5YWU3MWNiMWY2MDM5MzZiYmMzN2M5YjZmYzBmMzVjZjY3Nzg=
+  metadata.gz: 7f439061492bb9ebc9d61577fc220a8b1b2c609304442054bba56b2db2768f3a30697a2f1c70d8c28942b4b5bc336384bd7ffa8ebbeb5b4e038a1a86ea9b5e77
+  data.tar.gz: b753d3240fc152cf4cb1fa2bd26a2e1f4cbdae3c99c20d1b4cef71abc76b7ca149119cbdf5b359c5a42e227a1242be637112663196ce3aab696e0a92058bc5d5

data/.gitignore

@@ -0,0 +1,7 @@
+*.gem
+.bundle
+.yardoc
+coverage
+Gemfile.lock
+doc/*
+pkg/*

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--require spec_helper
+--order random

data/.travis.yml

@@ -0,0 +1,9 @@
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+  - 2.2.0
+  - 2.3.0

data/Gemfile

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

data/README.md

@@ -0,0 +1,14 @@
+# turbot-api
+
+[![Gem Version](https://badge.fury.io/rb/turbot-api.svg)](https://badge.fury.io/rb/turbot-api)
+[![Build Status](https://secure.travis-ci.org/openc/turbot-api.png)](https://travis-ci.org/openc/turbot-api)
+[![Dependency Status](https://gemnasium.com/openc/turbot-api.png)](https://gemnasium.com/openc/turbot-api)
+[![Coverage Status](https://coveralls.io/repos/openc/turbot-api/badge.png)](https://coveralls.io/r/openc/turbot-api)
+[![Code Climate](https://codeclimate.com/github/openc/turbot-api.png)](https://codeclimate.com/github/openc/turbot-api)
+
+## Releasing a new version
+
+Bump the version in `lib/turbot/api/version.rb` according to the [Semantic Versioning](http://semver.org/) convention, then:
+
+    git commit lib/turbot/api/version.rb -m 'Release new version'
+    rake release # requires Rubygems credentials

data/Rakefile

@@ -0,0 +1,16 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new
+rescue LoadError
+  task :yard do
+    abort 'YARD is not available. In order to run yard, you must: gem install yard'
+  end
+end

data/lib/turbot/api.rb

@@ -0,0 +1,123 @@
+require 'cgi'
+require 'json'
+
+require 'rest_client'
+
+require 'turbot/api/response'
+
+module Turbot
+  class API
+    def initialize(params)
+      @host = params[:host]
+      @port = params[:port]
+      @scheme = params[:scheme]
+      @api_key = params[:api_key] || get_api_key_for_credentials(params[:username], params[:password])['api_key']
+    end
+
+    # @return [Hash] a hash with the user's details
+    def get_user
+      response = request(:get, '/api/user')
+
+      # For backwards compatibility, this method must return a Hash, not a SuccessResponse.
+      JSON.load(response.body)
+    end
+
+    # @return [String] the user's API key
+    def get_api_key
+      get_user['api_key']
+    end
+
+    # @return [Hash] a hash with a single key "api_key"
+    def get_api_key_for_credentials(user, password)
+      response = request(:get, '/api/user/api_key', {
+        :email => user,
+        :password => password,
+      })
+
+      # For backwards compatibility, this method must return a Hash, not a SuccessResponse.
+      JSON.load(response.body)
+    end
+
+    # @return [Turbot::API::SuccessResponse, Turbot::API::FailureResponse]
+    def list_bots
+      request(:get, '/api/bots')
+    end
+
+    # @return [Turbot::API::SuccessResponse, Turbot::API::FailureResponse]
+    def show_bot(bot_id)
+      request(:get, "/api/bots/#{bot_id}")
+    end
+
+    # @return [Turbot::API::SuccessResponse, Turbot::API::FailureResponse]
+    def create_bot(bot_id, config, env = nil)
+      request(:post, '/api/bots', :bot => {:bot_id => bot_id, :config => config, :env => env})
+    end
+
+    # @return [Turbot::API::SuccessResponse, Turbot::API::FailureResponse]
+    def update_bot(bot_id, config, env = nil)
+      request(:put, "/api/bots/#{bot_id}", :bot => {:config => config, :env => env})
+    end
+
+    # @return [Turbot::API::SuccessResponse, Turbot::API::FailureResponse]
+    def show_manifest(bot_id)
+      request(:get, "/api/bots/#{bot_id}/manifest")
+    end
+
+    # @return [Turbot::API::SuccessResponse, Turbot::API::FailureResponse]
+    def create_draft_data(bot_id, batch)
+      request(:post, "/api/bots/#{bot_id}/draft_data", :batch => batch)
+    end
+
+    # @return [Turbot::API::SuccessResponse, Turbot::API::FailureResponse]
+    def destroy_draft_data(bot_id)
+      request(:delete, "/api/bots/#{bot_id}/draft_data")
+    end
+
+    # @return [Turbot::API::SuccessResponse, Turbot::API::FailureResponse]
+    def update_code(bot_id, archive)
+      request(:put, "/api/bots/#{bot_id}/code", {:archive => archive}, false)
+    end
+
+    # @return [Turbot::API::SuccessResponse, Turbot::API::FailureResponse]
+    def start_run(bot_id)
+      request(:post, "/api/bots/#{bot_id}/run/start")
+    end
+
+    # @return [Turbot::API::SuccessResponse, Turbot::API::FailureResponse]
+    def stop_run(bot_id)
+      request(:post, "/api/bots/#{bot_id}/run/stop")
+    end
+
+  private
+
+    def build_url_and_params(path, params = {})
+      url = URI::HTTP.build({
+        :host => @host,
+        :port => @port,
+        :scheme => @scheme,
+        :path => path.strip,
+      }).to_s
+
+      params[:api_key] = @api_key
+
+      [url, params]
+    end
+
+    def request(method, path, params = {}, json = true)
+      url, params = build_url_and_params(path, params)
+
+      begin
+        if method == :get || method == :delete
+          response = RestClient.send(method, url, :params => params)
+        elsif json == false
+          response = RestClient.send(method, url, params)
+        else
+          response = RestClient.send(method, url, JSON.dump(params), :content_type => :json)
+        end
+        SuccessResponse.new(response)
+      rescue RestClient::Exception => e
+        FailureResponse.new(e.response)
+      end
+    end
+  end
+end

data/lib/turbot/api/response.rb

@@ -0,0 +1,31 @@
+module Turbot
+  class API
+    class Response < SimpleDelegator
+      attr_reader :message
+
+      def initialize(response)
+        super
+        @parsed_body = JSON.parse(response.body, :symbolize_names => true)
+        @message = @parsed_body[:message]
+      end
+    end
+
+    class SuccessResponse < Response
+      attr_reader :data
+
+      def initialize(response)
+        super
+        @data = @parsed_body[:data]
+      end
+    end
+
+    class FailureResponse < Response
+      attr_reader :error_code
+
+      def initialize(response)
+        super
+        @error_code = @parsed_body[:error_code]
+      end
+    end
+  end
+end

data/lib/turbot/api/version.rb

@@ -0,0 +1,5 @@
+module Turbot
+  class API
+    VERSION = '0.0.17'
+  end
+end

data/lib/turbot_api.rb

@@ -1,2 +1,2 @@
-require 'turbot_api/api'
-require 'turbot_api/errors'
+# `require 'turbot_api'` is deprecated. Use `require 'turbot/api'`.
+require 'turbot/api'

data/spec/api_spec.rb

@@ -1,25 +1,83 @@
-require 'turbot_api'
+require 'spec_helper'
 
-describe Turbot::API do
-  before do
-    @api = Turbot::API.new(:api_key => 'key', :host => 'example.com')
+RSpec.describe Turbot::API do
+  let :api do
+    Turbot::API.new(:host => 'example.com', :api_key => 'key')
+  end
+
+  let :api_without_key do
+    Turbot::API.new(:host => 'example.com', :api_key => '')
+  end
+
+  describe '#get_user' do
+    it 'succeeds' do
+      body = {
+        'email' => 'email@example.com',
+        'last_sign_in_at' => '2015-01-01T00:00:00.000Z',
+        'api_key' => 'key',
+        'bot_count' => 5,
+      }
+
+      expect(RestClient).to receive(:get).
+        with('http://example.com/api/user', :params => {:api_key => 'key'}).
+        and_return(double(:body => JSON.dump(body)))
+
+      result = api.get_user
+      expect(result).to be_a(Hash)
+      expect(result).to eq(body)
+    end
+  end
+
+  describe '#get_api_key_for_credentials' do
+    it 'succeeds' do
+      body = {
+        'api_key' => 'key'
+      }
+
+      expect(RestClient).to receive(:get).
+        with('http://example.com/api/user/api_key', :params => {:email => 'email@example.com', :password => 'pass', :api_key => ''}).
+        and_return(double(:body => JSON.dump(body)))
+
+      result = api_without_key.get_api_key_for_credentials('email@example.com', 'pass')
+      expect(result).to be_a(Hash)
+      expect(result).to eq(body)
+    end
+  end
+
+  describe '#update_code' do
+    it 'succeeds' do
+      data = {}
+      body = JSON.dump({
+        :data => data,
+      })
+
+      expect(RestClient).to receive(:put).
+        with('http://example.com/api/bots/example/code', :api_key => 'key', :archive => 'binary').
+        and_return(double(:body => body))
+
+      result = api.update_code('example', 'binary')
+      expect(result).to be_a(Turbot::API::SuccessResponse)
+      expect(result.body).to eq(body)
+      expect(result.message).to eq(nil)
+      expect(result.data).to eq(data)
+    end
   end
 
   describe '#start_run' do
     it 'starts a run' do
-      RestClient.should_receive(:post).
-        with('http://example.com/api/bots/test-bot/run/start', :api_key => 'key').
-        and_return(double(:body => {}.to_json))
-      @api.start_run('test-bot')
+      expect(RestClient).to receive(:post).
+        with('http://example.com/api/bots/test-bot/run/start', JSON.dump(:api_key => 'key') , :content_type => :json).
+        and_return(double(:body => JSON.dump({})))
+      api.start_run('test-bot')
     end
   end
 
   describe '#stop_run' do
     it 'stops a run' do
-      RestClient.should_receive(:post).
-        with('http://example.com/api/bots/test-bot/run/stop', :api_key => 'key').
-        and_return(double(:body => {}.to_json))
-      @api.stop_run('test-bot')
+      expect(RestClient).to receive(:post).
+        with('http://example.com/api/bots/test-bot/run/stop', JSON.dump(:api_key => 'key'), :content_type => :json).
+        and_return(double(:body => JSON.dump({})))
+      api.stop_run('test-bot')
     end
   end
 end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require 'rubygems'
+
+require 'simplecov'
+require 'coveralls'
+SimpleCov.formatter = Coveralls::SimpleCov::Formatter
+SimpleCov.start do
+  add_filter 'spec'
+end
+
+require 'rspec'
+require File.dirname(__FILE__) + '/../lib/turbot/api'

data/turbot-api.gemspec

@@ -0,0 +1,23 @@
+require File.expand_path('../lib/turbot/api/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name    = "turbot-api"
+  gem.version = Turbot::API::VERSION
+
+  gem.author      = "OpenCorporates"
+  gem.email       = "bots@opencorporates.com"
+  gem.homepage    = "https://github.com/openc/turbot-api"
+  gem.summary     = "Turbot API client"
+  gem.license     = "MIT"
+
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.require_paths = ["lib"]
+
+  gem.add_runtime_dependency('rest-client', '~> 1.8')
+
+  gem.add_development_dependency('coveralls')
+  gem.add_development_dependency('rake')
+  gem.add_development_dependency('rspec', '~> 3.4')
+end

metadata

@@ -1,56 +1,91 @@
 --- !ruby/object:Gem::Specification
 name: turbot-api
 version: !ruby/object:Gem::Version
-  version: 0.0.16
+  version: 0.0.17
 platform: ruby
 authors:
-- Turbot
+- OpenCorporates
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-10 00:00:00.000000000 Z
+date: 2016-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.6.1
+        version: '1.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.6.1
+        version: '1.8'
 - !ruby/object:Gem::Dependency
-  name: rubyzip
+  name: coveralls
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Client library to deploy apps on Turbot.
-email: support@opencorporates.com
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+description: 
+email: bots@opencorporates.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
 - README.md
+- Rakefile
+- lib/turbot/api.rb
+- lib/turbot/api/response.rb
+- lib/turbot/api/version.rb
 - lib/turbot_api.rb
-- lib/turbot_api/api.rb
-- lib/turbot_api/errors.rb
-- lib/turbot_api/version.rb
 - spec/api_spec.rb
-homepage: http://opencorporates.com/
+- spec/spec_helper.rb
+- turbot-api.gemspec
+homepage: https://github.com/openc/turbot-api
 licenses:
 - MIT
 metadata: {}
@@ -60,19 +95,21 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
-summary: Client library to deploy apps on Turbot.
-test_files: []
+summary: Turbot API client
+test_files:
+- spec/api_spec.rb
+- spec/spec_helper.rb
 has_rdoc: 

data/lib/turbot_api/api.rb

@@ -1,152 +0,0 @@
-require 'json'
-require 'rest_client'
-require 'cgi'
-
-module Turbot
-  class API
-    def initialize(params)
-      @headers = params[:headers]
-      @host = params[:host]
-      @port = params[:port]
-      @username = params[:username]
-      @password = params[:password]
-      @scheme = params[:scheme]
-      @ssl_verify_peer = params[:ssl_verify_peer]
-      @api_key = params[:api_key] || get_api_key_for_credentials(@username, @password)["api_key"]
-    end
-
-    def get_user
-      # TODO move away from using RestClient directly
-      response = RestClient.get(server_req("/api/user"))
-      JSON.parse(response)
-    end
-
-    def get_api_key
-      get_user["api_key"]
-    end
-
-    def get_api_key_for_credentials(user, password)
-      # TODO move away from using RestClient directly
-      url = server_req("/api/user/api_key",
-        :email => user,
-        :password => password)
-      response = RestClient.get(url)
-      JSON.parse(response)
-    end
-
-    def list_bots
-      request(:get, "/api/bots")
-    end
-
-    def show_bot(bot_id)
-      request(:get, "/api/bots/#{bot_id}")
-    end
-
-    def create_bot(bot_id, config)
-      request(:post, "/api/bots", :bot => {:bot_id => bot_id, :config => config})
-    end
-
-    def update_bot(bot_id, config)
-      request(:put, "/api/bots/#{bot_id}", :bot => {:config => config})
-    end
-
-    def show_manifest(bot_id)
-      request(:get, "/api/bots/#{bot_id}/manifest")
-    end
-
-    def create_draft_data(bot_id, batch)
-      request(:post, "/api/bots/#{bot_id}/draft_data", :batch => batch)
-    end
-
-    def destroy_draft_data(bot_id)
-      request(:delete, "/api/bots/#{bot_id}/draft_data")
-    end
-
-    def update_code(bot_id, archive)
-      # We can't use #request here since we're not sending JSON
-      url = build_url("/api/bots/#{bot_id}/code")
-      begin
-        response = RestClient.put(url, :api_key => @api_key, :archive => archive)
-        SuccessResponse.new(response)
-      rescue RestClient::Exception => e
-        FailureResponse.new(e.response)
-      end
-    end
-
-    def start_run(bot_id)
-      request(:post, "/api/bots/#{bot_id}/run/start")
-    end
-
-    def stop_run(bot_id)
-      request(:post, "/api/bots/#{bot_id}/run/stop")
-    end
-
-    def get_ssh_keys
-      []
-    end
-
-    def post_key(key)
-    end
-
-    private
-
-    def server_req(path, params={})
-      query_string = params.update(:api_key => @api_key).map do |k, v|
-        "#{k}=#{CGI::escape(v)}" if v
-      end.compact.join("&")
-      args = {
-        :host => @host,
-        :port => @port,
-        :scheme => @scheme,
-        :path => path.strip
-      }
-      args[:query] = query_string unless query_string.empty?
-      URI::HTTP.build(args).to_s
-    end
-
-    def request(method, path, params={})
-      url = build_url(path)
-
-      begin
-        if method == :get || method == :delete
-          response = RestClient.send(method, url, :params => params.merge(:api_key => @api_key))
-        else
-          response = RestClient.send(method, url, params.merge(:api_key => @api_key).to_json, :content_type => :json)
-        end
-        SuccessResponse.new(response)
-      rescue RestClient::Exception => e
-        FailureResponse.new(e.response)
-      end
-    end
-
-    def build_url(path)
-      args = {
-        :host => @host,
-        :port => @port,
-        :scheme => @scheme,
-        :path => path.strip
-      }
-      url = URI::HTTP.build(args).to_s
-    end
-
-    class SuccessResponse
-      attr_reader :message, :data
-
-      def initialize(response)
-        data = JSON.parse(response.body, :symbolize_names => true)
-        @message = data[:message]
-        @data = data[:data]
-      end
-    end
-
-    class FailureResponse
-      attr_reader :message, :data
-
-      def initialize(response)
-        data = JSON.parse(response.body, :symbolize_names => true)
-        @error_code = data[:error_code]
-        @message = data[:message]
-      end
-    end
-  end
-end

data/lib/turbot_api/errors.rb

@@ -1,28 +0,0 @@
-module Turbot
-  class API
-    module Errors
-      class Error < StandardError; end
-
-      class ErrorWithResponse < Error
-        attr_reader :response
-
-        def initialize(message, response=nil)
-          message = message << "\nbody: #{response.body.inspect}" if response
-          super message
-          @response = response
-        end
-      end
-
-      class Unauthorized < ErrorWithResponse; end
-      class VerificationRequired < ErrorWithResponse; end
-      class Forbidden < ErrorWithResponse; end
-      class NotFound < ErrorWithResponse; end
-      class Timeout < ErrorWithResponse; end
-      class Locked < ErrorWithResponse; end
-      class RateLimitExceeded < ErrorWithResponse; end
-      class RequestFailed < ErrorWithResponse; end
-      class NilApp < ErrorWithResponse; end
-      class MissingManifest < ErrorWithResponse; end
-    end
-  end
-end

data/lib/turbot_api/version.rb

@@ -1,3 +0,0 @@
-module Turbot
-  TURBOT_API_VERSION = "0.0.16"
-end