cc-terminal 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 427b3afc83f5bc223e98b076bf0d6c8fb08c7b37
+  data.tar.gz: aecf2ed8c990a4ae92e9447d90170cf8641d7f5f
+SHA512:
+  metadata.gz: 3740f125d965595ebb8e2a6c0e53081087f42d7fac7e99dafe6e769b1e0d87c21f14a73694b1dd38745b74faf9b54cd281d2ede1978ef5862f27c941568a049f
+  data.tar.gz: a797f43497f81b05557e8d739dbae4e1d54abbfeb166295fc18dba60ae22a868b0f15f5641eaac4342b7218f33a5afe5a7ca2b0f2e136cccbb051cd47509e7b1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.idea

data/.ruby-version

@@ -0,0 +1 @@
+2.0.0-p353

data/.yardopts

@@ -0,0 +1,3 @@
+--tag authentication:"Authentication"
+--tag required_option:"Required Option"
+--markup markdown

data/Gemfile

@@ -0,0 +1,15 @@
+source 'https://rubygems.org'
+
+gem 'rake'
+gem 'yard'
+group :development do
+  gem 'pry'
+end
+
+group :test do
+  gem 'webmock'
+  gem 'rspec', '>= 2.14'
+  gem 'simplecov', :require => false
+  gem "codeclimate-test-reporter", require: nil
+end
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Timor Tsentsiper
+
+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,33 @@
+# Terminal
+
+TODO: Write a gem description
+
+<a href="https://codeclimate.com/repos/53fce1de69568062c701f989/feed"><img src="https://codeclimate.com/repos/53fce1de69568062c701f989/badges/15eedb01e45d861429ca/gpa.svg" /></a>
+[![CircleCI](https://circleci.com/gh/RyzacInc/terminal/tree/master.svg?style=shield&circle-token=3c6941fc03c8252853e6f6a8922927bab1513f90)](https://circleci.com/gh/RyzacInc/terminal)
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'terminal'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install terminal
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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 @@
+require "bundler/gem_tasks"

data/lib/terminal.rb

@@ -0,0 +1,13 @@
+require "terminal/version"
+require "terminal/errors"
+require "terminal/request/encode_json"
+require "terminal/response/parse_json"
+require "terminal/response/raise_error_from_json"
+require "terminal/modules/create_and_manage_terminals"
+require "terminal/modules/create_and_manage_snapshots"
+require "terminal/modules/request_progress"
+require "terminal/modules/browse_snapshots_and_users"
+require "terminal/api"
+require "terminal/request"
+require "terminal/utils"
+require "terminal/client"

data/lib/terminal/api.rb

@@ -0,0 +1,15 @@
+module Terminal
+  module API
+    include Terminal::Modules::BrowseSnapshotsAndUsers
+    include Terminal::Modules::CreateAndManageTerminals
+    include Terminal::Modules::CreateAndManageSnapshots
+    include Terminal::Modules::RequestProgress
+   # include Terminal::Modules::CreateSnapshots
+   # include Terminal::Modules::ManageSnapshots
+   # include Terminal::Modules::BrowseSnapshots
+   # include Terminal::Modules::ManageUsers
+   # include Terminal::Modules::BrowseUsers
+   # include Terminal::Modules::ManageUsageAndCredits
+  end
+end
+

data/lib/terminal/client.rb

@@ -0,0 +1,55 @@
+
+module Terminal
+  class Client
+    include Terminal::API
+
+    API_VERSION = "v0.1"
+    API_URL = 'https://api.terminal.com'
+    API_PREFIX = API_URL + "/" + API_VERSION + "/"
+
+    attr_accessor :user_token, :access_token
+
+    def initialize( options = {})
+      options.each do | k, v |
+        if v.is_a?(Integer)
+          raise Terminal::APIConfigurationError
+        end
+        send(:"#{k}=", v)
+      end
+      yield(self) if block_given?
+    end
+
+    def post(path, params = {} )
+      request(:post, path, params)
+    end
+
+  private
+
+    def connection(options = {} )
+      @connection ||= Faraday.new(API_URL, options) do | conn |
+        conn.request   :encode_json
+        conn.adapter   :net_http
+        conn.response  :parse_json
+        conn.response  :raise_error_from_json
+      end
+    end
+
+    def request(method, path, params = {})
+      auth = params.delete(:auth)
+      params = params.merge(auth_params) if auth
+      connection.send(method.to_sym, API_PREFIX + path, params)
+    rescue Faraday::Error::TimeoutError, Timeout::Error => error
+      raise(Terminal::APITimeoutError.new(error))
+    end
+
+    def auth_params
+      params = {}
+      params[:access_token] = access_token
+      params[:user_token] = user_token
+      params
+    end
+  end
+end
+
+
+

data/lib/terminal/errors.rb

@@ -0,0 +1,22 @@
+module Terminal
+  class APITimeoutError < StandardError; end
+  class APIConfigurationError < StandardError; end
+
+  class APIResponseError < StandardError
+
+    attr_reader :message, :status
+    def initialize(body)
+      @message, @status = parse_error_body(body)
+      super(message)
+    end
+
+    private
+    def parse_error_body(body)
+      if body.nil?
+        ['', nil]
+      elsif body[:error]
+        [body[:error], body[:success]]
+      end
+    end
+  end
+end

data/lib/terminal/modules/browse_snapshots_and_users.rb

@@ -0,0 +1,67 @@
+require 'terminal/utils'
+
+module Terminal
+  module Modules
+    module BrowseSnapshotsAndUsers
+
+      include Terminal::Utils
+
+      # Get information about a snapshot
+      #
+      # @see https:://www.terminal.com/api/docs#get-snapshot
+      # @authentication No auth required
+      # @param snapshot_id [String] the id of the snapshot you want info about
+      # @return [Hash] snapshot information, top  level :snapshot [:title, :body, :readme, :tags ...] etc
+      def get_snapshot(snapshot_id)
+        perform(:post, 'get_snapshot', { :snapshot_id => snapshot_id })
+      end
+
+      # Get information about a user
+      #
+      # @see https:://www.terminal.com/api/docs#get-profile
+      # @authentication No auth required
+      # @param username [String] The user to look up
+      # @return [Hash] user information, top level :user [:name, :username, :url ...] etc
+      def get_profile(username)
+        perform(:post, 'get_profile', { :username => username })
+      end
+
+      # List public snapshots, optionally filtered by the owner's
+      # username, a tag, or the snapshot's featured status. Combinations of filters
+      # are fine.
+      #
+      # @see https://www.terminal.com/api/docs#list-public-snapshots
+      # @authentication No auth required
+      # @param username [String]
+      # @param options [Hash]
+      # @option options tag [String] tag the snapshot was created with
+      # @option options featured [Boolean] true/false
+      # @option options title [String] title of the snapshot
+      # @option options page [Integer] 0
+      # @option options perPage [Integer] results per page 10
+      # @option options sortby [String] popularity, date etc
+      # @return [Hash] hash of snapshots, top level key :snapshots
+      def list_public_snapshots(username, options = {})
+        options[:username] = username
+        perform(:post, 'list_public_snapshots', options)
+      end
+
+      # Get count of public snapshots, optionally filtered by the owner's
+      # username, a tag, or the snapshot's featured status. Combinations of filters
+      # are fine.
+      #
+      # @see https://www.terminal.com/api/docs#count-public-snapshots
+      # @authentication No auth required
+      # @param username [String]
+      # @param options [Hash]
+      # @option options tag [String] tag the snapshot was created with
+      # @option options featured [Boolean] true/false
+      # @option options title [String] title of the snapshot
+      # @return [Hash] has of 1 key the count, :snapshot_count
+      def count_public_snapshots(username, options = {})
+        options[:username] = username
+        perform(:post, 'count_public_snapshots', options)
+      end
+    end
+  end
+end

data/lib/terminal/modules/create_and_manage_snapshots.rb

@@ -0,0 +1,90 @@
+require 'terminal/utils'
+
+module Terminal
+  module Modules
+    module CreateAndManageSnapshots
+
+      include Terminal::Utils
+
+
+      # Returns a list of all your snapshots, filtered by options
+      #
+      # @see https://www.terminal.com/api/docs#list-snapshots
+      # @authentication Requires user_token and access_token
+      # @param options [Hash] options to filter results on
+      # @option options username [String] filter by the username
+      # @option options tag [String] filter by the tag
+      # @option options featured [Boolean] is it featured
+      # @option options title [String] the title of the snapshot
+      # @option options page [Integer] WTF
+      # @option options perPage [Integer] paginate results I think
+      # @option options sortby [String] popularity or date
+      # @return [Hash] of snapshots, the key :snapshots is top level
+      def list_snapshots(options = {})
+        options[:auth] = true
+        perform(:post, 'list_snapshots', options)
+      end
+
+      # Returns a count of all your snapshots, filtered by options
+      #
+      # @see https://www.terminal.com/api/docs#count-snapshots
+      # @authentication Requires user_token and access_token
+      # @param options [Hash] options to filter on
+      # @option options username [String] filter by the owner's username
+      # @option options tag [String] filter by a tag
+      # @option options featured [Boolean] filter by featured status
+      # @option options title [String] filter by the title of the snapshot
+      # @return [Hash] count, the key :snapshots_count is top level
+      def count_snapshots(options = {})
+        options[:auth] = true
+        perform(:post, 'count_snapshots', options)
+      end
+
+      # Delete a snapshot by id
+      #
+      # @see https://www.terminal.com/api/docs#delete-snapshot
+      # @authentication Requires user_token and access_token
+      # @param snapshot_id [String] the id of the snapshot to delete
+      # @return [Hash]
+      def delete_snapshot(snapshot_id)
+        options = {}
+        options[:auth] = true
+        options[:snapshot_id] = snapshot_id
+        perform(:post, 'delete_snapshot', options)
+      end
+
+      # Edit the metadata of a snapshot owned by your account.
+      #
+      # @see https://www.terminal.com/api/docs#edit-snapshot
+      # @authentication Require user_token and access token
+      # @param snapshot_id [String] the id of the snapshot you want to edit
+      # @param options [Hash] options you want to edit (snapshot meta data)
+      # @option options body [String]
+      # @option options title [String]
+      # @option options readme [String]
+      # @option options tags [Array]
+      # @option options public [Boolean]
+      def edit_snapshot(snapshot_id, options ={})
+        options[:auth] = true
+        options[:snapshot_id] = snapshot_id
+        perform(:post, 'edit_snapshot', options)
+      end
+
+      # Create a snapshot of a terminal instance, but it actually makes no sense
+      #
+      # @see https://www.terminal.com/api/docs#snapshot-terminal
+      # @authentication Requires user_token and access_token
+      # @param container_key [String]
+      # @param snapshot_id [String]
+      # @param options [Hash]
+      # @option options body
+      # @return [Hash]
+      def snapshot_terminal(container_key, snapshot_id, options = {})
+        options[:auth] = true
+        options[:container_key] = container_key
+        options[:snapshot_id] = snapshot_id
+        perform(:post, 'snapshot_terminal', options)
+      end
+    end
+  end
+end

data/lib/terminal/modules/create_and_manage_terminals.rb

@@ -0,0 +1,125 @@
+require 'terminal/utils'
+
+module Terminal
+  module Modules
+    module CreateAndManageTerminals
+
+      include Terminal::Utils
+
+      # Returns a list of all your terminals
+      #
+      # @see https://www.terminal.com/api/docs#list-terminals
+      # @authentication Requires user_token and access_token
+      # @return [Hash] of terminals, the key :terminals is top level
+      def list_terminals
+        options = {}
+        options[:auth] = true
+        perform(:post, 'list_terminals', options )
+      end
+
+      # Returns info about a specific terminal
+      #
+      # @see https://www.terminal.com/api/docs#get-terminal
+      # @authentication Requires user_token and access_token
+      # @param container_key [String] the id/key of the container and is optional
+      # @param subdomain [String] the sub domain of the terminal and is optional
+      # @return [Hash] represents one terminal, the hash is its attributes
+      def get_terminal(container_key = nil, subdomain = nil)
+        options = {}
+        options[:auth] = true
+        options[:container_key] = container_key unless container_key.nil?
+        options[:subdomain] = subdomain unless subdomain.nil?
+        perform(:post, 'get_terminal', options)
+      end
+
+      # Start a terminal instance based on a snapshot
+      #
+      # @see https://www.terminal.com/api/docs#start-snapshot
+      # @authentication Requires user_token and access_token
+      # @param snapshot_id [String] the id of the snapshot you are trying to start
+      # @param options [Hash] options to add to the request
+      # @option options cpu [String] Example: "2 (max)" unclear if this is even honored by Terminal.com api
+      # @option options ram [String]
+      # @option options temporary [Boolean]
+      # @option options name [String]
+      # @option options autopause [Boolean]
+      # @option options startup_script [String]
+      # @return [Hash] represents the request_id you just made (to check its status is another call)
+      def start_snapshot(snapshot_id, options = {})
+        options[:auth] = true
+        options[:snapshot_id] = snapshot_id
+        perform(:post, 'start_snapshot', options)
+      end
+
+      # Delete a terminal instance
+      #
+      # @see https://www.terminal.com/api/docs#delete-terminal
+      # @authentication Requires user_token and access_token
+      # @param container_key [String] the key of the terminal you are trying to delete
+      # @return [Hash] represents the :status of the request and the :result
+      def delete_terminal(container_key)
+        options = {}
+        options[:auth] = true
+        options[:container_key] = container_key
+        perform(:post, 'delete_terminal', options)
+      end
+
+      # Restart a terminal instance
+      #
+      # @see https://www.terminal.com/api/docs#restart-terminal
+      # @authentication Requires user_token and access_token
+      # @param container_key [String] the key of the terminal you are trying to restart
+      # @return [Hash] represents the request_id that was made on the API
+      def restart_terminal(container_key)
+        options = {}
+        options[:auth] = true
+        options[:container_key] = container_key
+        perform(:post, 'restart_terminal', options)
+      end
+
+      # Pause a terminal instance
+      #
+      # @see https://www.terminal.com/api/docs#pause-terminal
+      # @authentication Requires user_token and access_token
+      # @param container_key [String] the key of the terminal you are trying to pause
+      # @return [Hash] represents the request_id that was made on the API
+      def pause_terminal(container_key)
+        options = {}
+        options[:auth] = true
+        options[:container_key] = container_key
+        perform(:post, 'pause_terminal', options)
+      end
+
+      # Resume a terminal instance
+      #
+      # @see https://www.terminal.com/api/docs#resume-terminal
+      # @authentication Requires user_token and access_token
+      # @param container_key [String] the key of the terminal you are trying to resume
+      # @return [Hash] represents the request_id that was made on the API
+      def resume_terminal(container_key)
+        options = {}
+        options[:auth] = true
+        options[:container_key] = container_key
+        perform(:post, 'resume_terminal', options)
+      end
+
+      # Edit the resources and/or name of a Terminal instance
+      #
+      # @see https://www.terminal.com/api/docs#edit-terminal
+      # @authentication Requires user_token and access_token
+      # @param container_key [String] the id of the terminal you are trying to edit
+      # @param required_options [Hash] hash of other required params cpu, ram, diskspace, name
+      # @required_option cpu [String] cpu of the terminal to edit to
+      # @required_option ram [String] ram to edit the terminal to
+      # @required_option cpu [String] disk space to edit to
+      # @required_option name [String] name to edit the terminal to
+      # @return [Hash] Hash containing the :status and the :request_id for the request
+      def edit_terminal(container_key, required_options ={})
+        required_options[:auth] = true
+        requireed_options[:container_key] = container_key
+        perform(:post, 'edit_terminal', required_options)
+      end
+
+    end
+  end
+end

data/lib/terminal/modules/request_progress.rb

@@ -0,0 +1,20 @@
+require 'terminal/utils'
+
+module Terminal
+  module Modules
+    module RequestProgress
+      include Terminal::Utils
+
+      # Get info and status of an API request
+      #
+      # @see https://www.terminal.com/api/docs#request-progress
+      # @param request_id [String] the request id you are trying to get more info about
+      # @return [Hash] of terminals, the key :terminals is top level
+      def request_progress(request_id)
+        options = {}
+        options[:request_id] = request_id
+        perform(:post, 'request_progress', options )
+      end
+    end
+  end
+end

data/lib/terminal/request.rb

@@ -0,0 +1,16 @@
+module Terminal
+  class Request
+    attr_accessor :client, :request_method, :path, :options
+
+    def initialize(client, request_method, path, options = {})
+      @client = client
+      @request_method = request_method
+      @path = path
+      @options = options
+    end
+
+    def perform
+      @client.send(@request_method, @path, @options).body
+    end
+  end
+end

data/lib/terminal/request/encode_json.rb

@@ -0,0 +1,52 @@
+# From https://github.com/lostisland/faraday_middleware/blob/master/lib/faraday_middleware/request/encode_json.rb
+require 'faraday'
+require 'json'
+
+module Terminal
+  module RequestExt
+    class EncodeJson < Faraday::Middleware
+      CONTENT_TYPE = 'Content-Type'.freeze
+      MIME_TYPE    = 'application/json'.freeze
+
+      dependency do
+        require 'json' unless defined?(::JSON)
+      end
+
+      def call(env)
+        match_content_type(env) do |data|
+          env[:body] = encode data
+        end
+        @app.call env
+      end
+
+      def encode(data)
+        ::JSON.dump data
+      end
+
+      def match_content_type(env)
+        if process_request?(env)
+          env[:request_headers][CONTENT_TYPE] ||= MIME_TYPE
+          yield env[:body] unless env[:body].respond_to?(:to_str)
+        end
+      end
+
+      def process_request?(env)
+        type = request_type(env)
+        has_body?(env) and (type.empty? or type == MIME_TYPE)
+      end
+
+      def has_body?(env)
+        body = env[:body] and !(body.respond_to?(:to_str) and body.empty?)
+      end
+
+      def request_type(env)
+        type = env[:request_headers][CONTENT_TYPE].to_s
+        type = type.split(';', 2).first if type.index(';')
+        type
+      end
+    end
+
+  end
+end
+
+Faraday::Request.register_middleware :encode_json => Terminal::RequestExt::EncodeJson

data/lib/terminal/response/parse_json.rb

@@ -0,0 +1,31 @@
+# From https://github.com/sferik/twitter/blob/master/lib/twitter/rest/response/parse_json.rb
+require 'faraday'
+require 'json'
+
+
+module Terminal
+  module ResponseExt
+    class ParseJson < Faraday::Response::Middleware
+      WHITESPACE_REGEX = /\A^\s*$\z/
+
+      def parse(body)
+        case body
+          when WHITESPACE_REGEX, nil
+            nil
+          else
+            JSON.parse(body, :symbolize_names => true)
+        end
+      end
+
+      def on_complete(response)
+        response.body = parse(response.body) if respond_to?(:parse) && !unparsable_status_codes.include?(response.status)
+      end
+
+      def unparsable_status_codes
+        [204, 301, 302, 304]
+      end
+    end
+  end
+end
+
+Faraday::Response.register_middleware :parse_json => Terminal::ResponseExt::ParseJson

data/lib/terminal/response/raise_error_from_json.rb

@@ -0,0 +1,23 @@
+require 'faraday'
+require 'json'
+
+
+module Terminal
+  module ResponseExt
+    class RaiseErrorFromJson < Faraday::Response::Middleware
+      def on_complete(response)
+        # Terminal.com always returns 200
+        code = response.status.to_i
+        body =  JSON.parse(response.body, :symbolize_names => true)
+        if code == 200 && body[:success] == false || !body[:error].nil?
+          fail(Terminal::APIResponseError.new(body))
+        else
+           # How did we get here?
+        end
+      end
+
+    end
+  end
+end
+
+Faraday::Response.register_middleware :raise_error_from_json => Terminal::ResponseExt::RaiseErrorFromJson

data/lib/terminal/utils.rb

@@ -0,0 +1,11 @@
+module Terminal
+  module Utils
+
+    private
+
+    def perform(request_method, path, options)
+      request = Terminal::Request.new(self, request_method, path, options)
+      request.perform
+    end
+end
+end

data/lib/terminal/version.rb

@@ -0,0 +1,3 @@
+module Terminal
+  VERSION = "0.0.2"
+end

data/spec/fixtures/count_public_snapshots.json

@@ -0,0 +1 @@
+{"snapshot_count":19}

data/spec/fixtures/count_snapshots.json

@@ -0,0 +1 @@
+{"snapshot_count":2}

data/spec/fixtures/delete_snapshot.json

@@ -0,0 +1 @@
+{"status":"success"}

data/spec/fixtures/edit_snapshot.json

@@ -0,0 +1 @@
+{:snapshot=>{:title=>"Timor Test", :body=>"Box With Authorized Keys", :display_style=>"readme", :readme=>"", :pynb=>"", :tags=>"", :image=>{:files=>["1406148593621.png"], :cdnUri=>"http://s3-us-west-2.amazonaws.com/com.terminal.imager"}, :diskspace=>10, :ram=>256, :public=>false, :start_count=>0, :createdAt=>"2014-09-03T16:19:28.672Z", :featured=>false, :author=>"codecademy", :id=>"4d9047f516b4c4861db55b52c9130393fb188e97e7f7831551090def8a8f90e8"}, :success=>true}

data/spec/fixtures/error_response.json

@@ -0,0 +1 @@
+{"error":"No such user"}

data/spec/fixtures/get_profile.json

@@ -0,0 +1 @@
+{"user":{"name":"varun","username":"varunc","url":"http://www.stanford.edu/~varung","company":"Terminal.com","location":"San Francisco, CA","profile_image":"//www.gravatar.com/avatar/e06ae167720f9383b8b34aa0a5fddd8d.jpg?s=400&d=mm"}}

data/spec/fixtures/get_snapshot.json

@@ -0,0 +1 @@
+{"snapshot":{"title":"Official Centos 6","body":"Official Centos 6 distribution with minimal stack for running Terminal.com IDE. Install anything, you have root access.","display_style":"readme","readme":"","pynb":"","tags":"centos","image":{"files":["1406144007836.png"],"cdnUri":"http://s3-us-west-2.amazonaws.com/com.terminal.imager"},"diskspace":10,"ram":256,"public":true,"start_count":3153,"createdAt":"2014-07-23T19:32:31.207Z","comments":[],"featured":true,"author":"terminal","id":"2dca905d923d8154c555c5271cbba75927cb3fd705aba1eb9d93cbd59e3ef100"}}

data/spec/fixtures/list_public_snapshots.json

@@ -0,0 +1 @@
+{"snapshots":[{"title":"Official Centos 6","body":"Official Centos 6 distribution with minimal stack for running Terminal.com IDE. Install anything, you have root access.","display_style":"readme","readme":"","pynb":"","tags":"centos","image":{"files":["1406144007836.png"],"cdnUri":"http://s3-us-west-2.amazonaws.com/com.terminal.imager"},"diskspace":10,"ram":256,"public":true,"start_count":2261,"createdAt":"2014-08-01T15:52:53.392Z","featured":false,"author":"terminal","id":"7055b7ad84fa386fd023cf9bdb91434a09c97daede1624705777aa9b4758e44b"},{"title":"Official Scientific Linux 6","body":"Official Scientific Linux 6 distribution with minimal stack for running Terminal.com IDE. Install anything, you have root access.","display_style":"readme","readme":"","pynb":"","tags":"scientific-linux","image":{"files":["1406152673695.png"],"cdnUri":"http://s3-us-west-2.amazonaws.com/com.terminal.imager"},"diskspace":10,"ram":256,"public":true,"start_count":1016,"createdAt":"2014-07-23T21:56:13.810Z","featured":true,"author":"terminal","id":"ee99eb373155dd321e65664e0987d5a5ac7de71a63c62117a33f9c1b7074bbbf"},{"title":"Official Ubuntu 14.04","body":"Official Ubuntu 14.04 distribution with minimal stack for running Terminal.com IDE. Install anything, you have root access.","display_style":"readme","readme":"","pynb":"","tags":"ubuntu","image":{"files":["1406148593621.png"],"cdnUri":"http://s3-us-west-2.amazonaws.com/com.terminal.imager"},"diskspace":10,"ram":256,"public":true,"start_count":3153,"createdAt":"2014-07-23T20:27:41.743Z","featured":true,"author":"terminal","id":"987f8d702dc0a6e8158b48ccd3dec24f819a7ccb2756c396ef1fd7f5b34b7980"},{"title":"Official Centos 6","body":"Official Centos 6 distribution with minimal stack for running Terminal.com IDE. Install anything, you have root access.","display_style":"readme","readme":"","pynb":"","tags":"centos","image":{"files":["1406144007836.png"],"cdnUri":"http://s3-us-west-2.amazonaws.com/com.terminal.imager"},"diskspace":10,"ram":256,"public":true,"start_count":3153,"createdAt":"2014-07-23T19:32:31.207Z","featured":true,"author":"terminal","id":"2dca905d923d8154c555c5271cbba75927cb3fd705aba1eb9d93cbd59e3ef100"},{"title":"Official Debian 7.0","body":"Official Debian 7.0 distribution with minimal stack for running Terminal.com IDE. Install anything, you have root access.","display_style":"readme","readme":"","pynb":"","tags":"debian","image":{"files":["1406143176054.png"],"cdnUri":"http://s3-us-west-2.amazonaws.com/com.terminal.imager"},"diskspace":10,"ram":256,"public":true,"start_count":2230,"createdAt":"2014-07-23T19:16:57.738Z","featured":true,"author":"terminal","id":"4bd31cfeb39ab2fdb8a84f0e4e6061f0ad0d718299198a3339c56bf32eda93fd"}]}

data/spec/fixtures/list_snapshots.json

@@ -0,0 +1 @@
+{"snapshots":[{"title":"Base","body":"Box With Authorized Keys","display_style":"readme","readme":"","pynb":"","tags":"","image":{"files":["1406148593621.png"],"cdnUri":"http://s3-us-west-2.amazonaws.com/com.terminal.imager"},"diskspace":10,"ram":256,"public":false,"start_count":0,"createdAt":"2014-08-20T14:51:00.894Z","featured":false,"author":"codecademy","id":"a2e2e283b3e50e61530b49487716ce668154cbb33fb18317078d976a87a54f92"},{"title":"Box With Keys","body":"Box With Authorized Keys","display_style":"readme","readme":"","pynb":"","tags":"","image":{"files":["1406148593621.png"],"cdnUri":"http://s3-us-west-2.amazonaws.com/com.terminal.imager"},"diskspace":10,"ram":256,"public":false,"start_count":1,"createdAt":"2014-08-18T21:12:37.987Z","featured":false,"author":"codecademy2","id":"88c27f6f1bb367e8fa0163e1dc22eec438a6d164ab8204e5827d2b5815f11945"}]}

data/spec/fixtures/list_terminals.json

@@ -0,0 +1 @@
+{"terminals":[{"cpu":"2 (max)","ram":"256","diskspace":"10","name":"Base","snapshot_id":"987f8d702dc0a6e8158b48ccd3dec24f819a7ccb2756c396ef1fd7f5b34b7980","temporary":"","status":"running","allow_spot":false,"container_key":"ade4d0fe-a98a-48e8-a087-6b7c8fe9c164","hostname":"codecademy2","subdomain":"codecademy2","container_ip":"192.0.65.8","creation_time":1408395945876},{"cpu":"2 (max)","ram":"256m","diskspace":"10","name":"Dan's Provisioning Box","snapshot_id":"88c27f6f1bb367e8fa0163e1dc22eec438a6d164ab8204e5827d2b5815f11945","temporary":"","status":"running","allow_spot":false,"container_key":"4c68a7c5-75a7-4a7b-a58f-3815f10258b1","hostname":"codecademy3","subdomain":"codecademy3","container_ip":"192.0.65.17","creation_time":1408399878526}]}

data/spec/fixtures/request_progress.json

@@ -0,0 +1 @@
+{"status":"success","result":{"cpu":"2 (max)","ram":256,"diskspace":10,"name":"Box With Keys","snapshot_id":"88c27f6f1bb367e8fa0163e1dc22eec438a6d164ab8204e5827d2b5815f11945","status":"running","allow_spot":false,"container_key":"64cb36a5-8393-433a-ad16-e6053b5509ea","subdomain":"codecademy8","container_ip":"192.0.75.196","creation_time":1409693130184},"operation":"create","state":"success"}

data/spec/helper.rb

@@ -0,0 +1,22 @@
+require 'terminal'
+require 'webmock/rspec'
+
+if ENV['CIRCLE_ARTIFACTS']
+  require 'simplecov'
+  dir = File.join("..", "..", "..", ENV['CIRCLE_ARTIFACTS'], "coverage")
+  SimpleCov.coverage_dir(dir)
+end
+
+def a_post(path)
+  a_request(:post, Terminal::Client::API_PREFIX + path)
+end
+
+def stub_post(path)
+  stub_request(:post, Terminal::Client::API_PREFIX + path)
+end
+
+def fixture(file)
+  f_path = File.expand_path('../fixtures', __FILE__)
+  File.new(f_path + '/' + file)
+end
+

data/spec/terminal/client_spec.rb

@@ -0,0 +1,41 @@
+require 'helper'
+
+describe Terminal::Client do
+  before do
+    @client = Terminal::Client.new(:access_token => 'blah', :user_token => 'blah2')
+  end
+
+  describe 'new instance of the client is defined' do
+
+    context 'when bad access_token,user_token are provided' do
+      it 'raises a configuration exception' do
+        expect { Terminal::Client.new(:access_token => 12121, :user_token => 12111111) }.to raise_exception(Terminal::APIConfigurationError)
+      end
+    end
+    context 'when no access_token,user_token are provided' do
+      it 'does not raise an exception' do
+        expect { Terminal::Client.new }.not_to raise_error
+      end
+    end
+  end
+
+  describe 'connection' do
+    it 'looks like a Faraday connection' do
+      expect(@client.send(:connection)).to respond_to(:run_request)
+    end
+  end
+
+  describe 'request' do
+    it 'catches Faraday Timeout errors and raises an API timeout error' do
+      allow(@client).to receive(:connection).and_raise(Faraday::Error::TimeoutError.new('expired'))
+      expect { @client.send(:request, :post, '/blah') }.to raise_error(Terminal::APITimeoutError)
+    end
+
+    it 'raises an API error from a response containing error JSON' do
+      stub_post('/path').to_return(:body => fixture('error_response.json'), :headers => {:content_type => 'application/json'})
+      expect { @client.send(:request, :post, '/path')}.to raise_error(Terminal::APIResponseError)
+    end
+  end
+
+end
+

data/spec/terminal/modules/browse_snapshots_and_users_spec.rb

@@ -0,0 +1,24 @@
+require 'helper'
+
+describe Terminal::Modules::BrowseSnapshotsAndUsers do
+  before do
+    @client = Terminal::Client.new(:access_token => 'blah', :user_token => 'blah2')
+  end
+
+  describe "get_snapshot" do
+    before do
+      stub_post('get_snapshot').to_return(:body => fixture('get_snapshot.json'), :headers => {:content_type => 'application/json'})
+    end
+
+    it 'calls the proper endpoint' do
+      @client.get_snapshot('some_id')
+      expect(a_post('get_snapshot')).to have_been_made
+    end
+
+    it 'returns a hash with some snapshot information' do
+      snapshot = @client.get_snapshot('some_id')
+      expect(snapshot[:snapshot]).to be_an(Hash)
+      expect(snapshot[:snapshot][:id]).to be_an(String)
+    end
+  end
+end

data/spec/terminal/modules/create_and_manage_snapshots_spec.rb

@@ -0,0 +1,27 @@
+require 'helper'
+
+describe Terminal::Modules::CreateAndManageSnapshots do
+  before do
+    @client = Terminal::Client.new(:access_token => 'blah', :user_token => 'blah2')
+  end
+
+  describe "get a list of snapshots" do
+    before do
+      stub_post('list_snapshots').to_return(:body => fixture('list_snapshots.json'), :headers => {:content_type => 'application/json'})
+    end
+
+    it 'posts to the proper endpoint' do
+      @client.list_snapshots
+      expect(a_post('list_snapshots')).to have_been_made
+    end
+
+    it 'contains a response that has some snapshots' do
+      snapshots = @client.list_snapshots
+      expect(snapshots).to be_an Hash
+      expect(snapshots[:snapshots]).to be_an Array
+      snapshot = snapshots[:snapshots].first
+      expect(snapshot).to be_an Hash
+    end
+
+  end
+end

data/spec/terminal/modules/create_and_manage_terminals_spec.rb

@@ -0,0 +1,25 @@
+require 'helper'
+
+describe Terminal::Modules::CreateAndManageTerminals do
+  before do
+    @client = Terminal::Client.new(:access_token => 'blah', :user_token => 'blah2')
+  end
+
+  describe "get a list of terminals" do
+    before do
+      stub_post('list_terminals').to_return(:body => fixture('list_terminals.json'), :headers => {:content_type => 'application/json'})
+    end
+
+    it 'posts to the proper endpoint' do
+      @client.list_terminals
+      expect(a_post('list_terminals')).to have_been_made
+    end
+
+    it 'contains a response that has some terminals' do
+      terminals = @client.list_terminals
+      expect(terminals).to be_an Hash
+      expect(terminals[:terminals]).to be_an Array
+      # Maybe check the actual structure here as well
+    end
+  end
+end

data/spec/terminal/modules/request_progress_spec.rb

@@ -0,0 +1,25 @@
+require 'helper'
+
+describe Terminal::Modules::RequestProgress do
+  before do
+    @client = Terminal::Client.new(:access_token => 'blah', :user_token => 'blah2')
+  end
+
+  describe "Request progress endpoint called" do
+    before do
+      stub_post('request_progress').to_return(:body => fixture('request_progress.json'), :headers => {:content_type => 'application/json'})
+    end
+
+    it 'posts to the proper endpoint' do
+      @client.request_progress(:request_id => "testestest")
+      expect(a_post('request_progress')).to have_been_made
+    end
+
+    it 'returns a hash that is properly formed' do
+      request_status = @client.request_progress(:request_id => 'test')
+      expect(request_status).to be_an(Hash)
+      expect(request_status[:status]).to be_truthy
+    end
+
+  end
+end

data/terminal.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'terminal/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "cc-terminal"
+  spec.version       = Terminal::VERSION
+  spec.authors       = ["Timor Tsentsiper"]
+  spec.email         = ["timor@codecademy.com"]
+  spec.description   = %q{Write a gem description}
+  spec.summary       = %q{Write a gem summary}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'json', '~> 1.8'
+  spec.add_dependency "faraday", '~> 0.9.0'
+  spec.required_ruby_version = '>= 2.0'
+end
+

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: cc-terminal
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Timor Tsentsiper
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+description: Write a gem description
+email:
+- timor@codecademy.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .ruby-version
+- .yardopts
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/terminal.rb
+- lib/terminal/api.rb
+- lib/terminal/client.rb
+- lib/terminal/errors.rb
+- lib/terminal/modules/browse_snapshots_and_users.rb
+- lib/terminal/modules/create_and_manage_snapshots.rb
+- lib/terminal/modules/create_and_manage_terminals.rb
+- lib/terminal/modules/request_progress.rb
+- lib/terminal/request.rb
+- lib/terminal/request/encode_json.rb
+- lib/terminal/response/parse_json.rb
+- lib/terminal/response/raise_error_from_json.rb
+- lib/terminal/utils.rb
+- lib/terminal/version.rb
+- spec/fixtures/count_public_snapshots.json
+- spec/fixtures/count_snapshots.json
+- spec/fixtures/delete_snapshot.json
+- spec/fixtures/edit_snapshot.json
+- spec/fixtures/error_response.json
+- spec/fixtures/get_profile.json
+- spec/fixtures/get_snapshot.json
+- spec/fixtures/list_public_snapshots.json
+- spec/fixtures/list_snapshots.json
+- spec/fixtures/list_terminals.json
+- spec/fixtures/request_progress.json
+- spec/helper.rb
+- spec/terminal/client_spec.rb
+- spec/terminal/modules/browse_snapshots_and_users_spec.rb
+- spec/terminal/modules/create_and_manage_snapshots_spec.rb
+- spec/terminal/modules/create_and_manage_terminals_spec.rb
+- spec/terminal/modules/request_progress_spec.rb
+- terminal.gemspec
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.1.11
+signing_key: 
+specification_version: 4
+summary: Write a gem summary
+test_files:
+- spec/fixtures/count_public_snapshots.json
+- spec/fixtures/count_snapshots.json
+- spec/fixtures/delete_snapshot.json
+- spec/fixtures/edit_snapshot.json
+- spec/fixtures/error_response.json
+- spec/fixtures/get_profile.json
+- spec/fixtures/get_snapshot.json
+- spec/fixtures/list_public_snapshots.json
+- spec/fixtures/list_snapshots.json
+- spec/fixtures/list_terminals.json
+- spec/fixtures/request_progress.json
+- spec/helper.rb
+- spec/terminal/client_spec.rb
+- spec/terminal/modules/browse_snapshots_and_users_spec.rb
+- spec/terminal/modules/create_and_manage_snapshots_spec.rb
+- spec/terminal/modules/create_and_manage_terminals_spec.rb
+- spec/terminal/modules/request_progress_spec.rb
+has_rdoc: