ServerPilot 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 66cb9861282795741aadd7d9ce6d82804e7bf835
-  data.tar.gz: d922e0c149d2ff21b1a47efd4e2c505fad5cab0a
+  metadata.gz: 1d44a36c34d4a41c172bf7a433091e810ed64fbf
+  data.tar.gz: 1f1f65da52d92ee8bcfeeefe71c243237b64c497
 SHA512:
-  metadata.gz: 35ade37164b91ec0763b04db0c34269110ac6f2b886bf6f50ee617f9fc98eb96dd6bd95614efc7c9a82263aeb01f6df0a5ce48e39fe851dc855e3bc153d4d601
-  data.tar.gz: e43399b08252874c5136e46544cc59ac56f494bd2023bb3dd66fc9af8722c260ec1cce2de3a8786a2fc5d8e5c7c14cdf52e777a59a23af57264a71c9df595153
+  metadata.gz: 124910be3eaa3cabd523078dbc35a5a83811ee5ac3362169875f61472b86b7b094beb7c8d06e63fc3d31ba427feb1653ef7b05a4a35e9133124c8d7c21771181
+  data.tar.gz: 6e72616b8065db191ddc615c7aa6a40c3fbd9e3c1c98e8f4781ff03beb89b2b8607c6ed4f802b8f74b4d0d6bdae2cca8a3e1999e2c948f19fb7f418a695f2191

data/.autotest

@@ -0,0 +1,2 @@
+require 'autotest/fsevent'
+require 'autotest/growl'

data/.gitignore

@@ -12,3 +12,5 @@
 *.o
 *.a
 mkmf.log
+.idea
+.DS_Store

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.0

data/README.md

@@ -1,36 +1,56 @@
 # ServerPilot
 
-ServerPilot
-===========
-
 Ruby client gem for accessing <a href="http://www.serverpilot.io" target="_blank">ServerPilot</a> API
+Current version (0.0.4). This version has been tested against a sinatra app at
+http://www.github.com/signalfire/serverpilot-sinatra to mock up calls to API methods.
 
-Install
--------
+## Installation
 
-Install from RubyGems with **gem install serverpilot** or clone from this github
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ServerPilot'
+```
 
-Project on RubyGems at <a href="https://rubygems.org/gems/serverpilot" target="_blank">https://rubygems.org/gems/serverpilot</a>
+And then execute:
 
-To create a connection **require 'serverpilot'**
+    $ bundle
 
-In your code add something like **sp = Signalfire::ServerPilot.new(client_id,key)**
+Or install it yourself as:
+
+    $ gem install ServerPilot
+
+## Usage
+
+To create a connection **require 'ServerPilot'**
+In your code add something like **sp = ServerPilot::API.new(api_client, api_key)**
 where client_id and key are your API information from ServerPilot.
 
-Functions
----------
+If the serverpilot api changes host, port, or scheme you can alter these using calls
+to properties on the class
+
+sp.scheme = 'http' or 'https'
+
+sp.host = 'newserverpilotaddress.io'
+
+sp.port = 1000
+
+These should be called before you start doing anything with the class
 
+## Functions
 Commands are issued such as sp.[verb]_[action]
 
 In use it would look something like:
+
 sp.get_servers 'UXOSIYrdtL4cSGp3'
+
 or using hash params:
-sp.post_sysusers {'serverid'=>'UXOSIYrdtL4cSGp3','name'=>'abc123',=>'password'=>'1234'}
+
+sp.post_sysusers {serverid: 'UXOSIYrdtL4cSGp3', name: 'abc123', password: '1234'}
 
 This is a list of the ruby functions to call on the server pilot object (e.g sp.get_servers)
 and matching ServerPilot API methods. [id] is the identifier of the server, app, database
-that you can retrieve via the API. [params] is a hash (Hash.new) of data to send to the
-api as JSON
+that you can retrieve via the API. [params] is a hash of data to send to the api as JSON
 
 <table width="100%">
 <tr>
@@ -154,32 +174,16 @@ api as JSON
 <td>GET /actions/:id</td>
 </tr>
 </table>
-This is early code and my first ever Ruby Gem so things may possibly break or not be quite
-ruby enough....
-
-## Installation
 
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'ServerPilot'
-```
+## Development
 
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install ServerPilot
-
-## Usage
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
 
-TODO: Write usage instructions here
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Contributing
 
-1. Fork it ( https://github.com/signalfire/ServerPilot/fork )
+1. Fork it ( https://github.com/[my-github-username]/ServerPilot/fork )
 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`)

data/Rakefile

@@ -1,2 +1 @@
-require "bundler/gem_tasks"
-
+require 'bundler/gem_tasks'

data/ServerPilot.gemspec

@@ -8,18 +8,18 @@ Gem::Specification.new do |spec|
   spec.version       = ServerPilot::VERSION
   spec.authors       = ['Robert Coster']
   spec.email         = ['rob@signalfire.co.uk']
-  spec.summary       ='ServerPilot'
-  spec.description   = 'An API client gem to allow interaction from Ruby with the ServerPilot.io API'
-  spec.homepage      = 'http://www.signalfire.co.uk'
-  spec.license       = 'MIT'
 
-  spec.files         = `git ls-files -z`.split("\x0")
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.summary       = 'An API client for interaction with ServerPilot API'
+  spec.description   = 'An API client for interaction with ServerPilot API'
+  spec.homepage      = 'http://www.github.com/signalfire/serverpilot'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.required_ruby_version = '>= 2.2'
+  spec.add_runtime_dependency 'rest-client', '>= 1.8.0'
+  spec.add_development_dependency 'bundler', '~> 1.8'
   spec.add_development_dependency 'rake', '~> 10.0'
-  spec.required_ruby_version = '~> 2.1'
-
 end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'ServerPilot'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/ServerPilot.rb

@@ -1,106 +1,130 @@
 require 'ServerPilot/version'
-require 'ServerPilot/connection'
+require 'rest-client'
+require 'uri'
+require 'json'
+require 'ostruct'
 
 module ServerPilot
-
+  # Class to access the serverpilot api
   class API
+    attr_accessor :scheme
+    attr_accessor :host
+    attr_accessor :port
+    attr_accessor :client_id
+    attr_accessor :secret_key
+
+    def initialize(api_client, api_key)
+      @client_id = api_client
+      @secret_key = api_key
+      @scheme = 'https'
+      @host = 'api.serverpilot.io'
+      @port = 443
+    end
 
-    def initialize(api_client_id, api_key)
-
-      @sp_client_id = api_client_id
-
-      @sp_key = api_key
+    def build_path(action, id = nil)
+      if action == 'ssl'
+        ['/v1', 'apps', id, 'ssl'].join('/') unless id.nil?
+      else
+        (id.nil?) ? ['/v1', action].join('/') : ['/v1', action, id].join('/')
+      end
+    end
 
+    def check_function_name_valid(name)
+      (name.to_s.include? '_') && (name.to_s.count('_') == 1) ? true : false
     end
 
-    def build_path(action, id = nil)
+    def get_function_verb(name)
+      case name.to_s.downcase
+      when /^get/ then 'get'
+      when /^post/ then 'post'
+      when /^delete/ then 'delete'
+      end
+    end
 
-      if action === 'ssl'
+    def get_params(arguments)
+      params = nil
+      arguments.each do |argument|
+        params = argument if argument.is_a?(Hash)
+      end
+      params
+    end
 
-        ['/v1', 'apps', id, 'ssl'] * '/'
+    def get_action_name(name)
+      name.to_s.downcase.split('_').last
+    end
 
+    def get_path(arguments, action)
+      if arguments.length == 0
+        build_path(action)
       else
-
-        if id
-          ['/v1', action, id] * '/'
+        if arguments[0].is_a?(Integer) || arguments[0].is_a?(String)
+          build_path(action, arguments[0])
         else
-          ['/v1', action] * '/'
+          build_path(action)
         end
-
       end
-
     end
 
-    def method_missing(name, *arguments)
-
-      #Check if name includes one and only one underscore
-      if (name.to_s.include? '_') && (name.to_s.count('_') === 1)
-
-        #Get the verb to call
-        verb = case name.to_s.downcase
-                 when /^get/ then 'get'
-                 when /^post/ then 'post'
-                 when /^delete/ then 'delete'
-                 else nil
-               end
-
-        #Check if the verb used is not nil
-        if verb
-
-          #Get the action to execute
-          action = name.to_s.downcase.split('_').last
-
-          #Check the number of arguments passed is zero
-          if arguments.length === 0
-
-            #Get the path (e.g. /servers) to call without id
-            path = build_path action
-
-          else
-
-            #Check if the first argument is an integer value
-            if (arguments[0].is_a? Integer) || (arguments[0].is_a? String)
-
-              #Get the path (e.g. /servers) to call passing the integer
-              path = build_path action, arguments[0]
-
-              #Check if the second argument is a hash and assign to params
-              if arguments[1].is_a? Hash
-                params = arguments[1]
-              end
-
-            else
-
-              #Get the path (e.g. /servers) to call
-              path = build_path action
-
-              #If the first argument is a hash
-              if arguments[0].is_a? Hash
-                params = arguments[0]
-              end
+    def create_uri(path)
+      URI::Generic.build(
+        scheme: @scheme,
+        host: @host,
+        path: path,
+        port: @port
+      ).to_s
+    end
 
-            end
+    def create_rest_client(verb, path, params = nil)
+      if params
+        RestClient::Request.new(
+          method: verb,
+          url: create_uri(path),
+          user: @client_id,
+          password: @secret_key,
+          headers: { 'Content-Type' => 'application/json' },
+          payload: params.to_json
+        )
+      else
+        RestClient::Request.new(
+          method: verb,
+          url: create_uri(path),
+          user: @client_id,
+          password: @secret_key
+        )
+      end
+    end
 
-          end
+    def execute_api_command(verb, path, params = nil)
+      client = create_rest_client verb, path, params
+      client.execute
+    end
 
-          #Create a new connection
-          connection = ServerPilot::Connection.new(@sp_client_id, @sp_key)
+    def parse_json(response)
+      body = JSON.parse(response.to_str) if response.code == 200
+      OpenStruct.new(code: response.code, body: body)
+    end
 
-          #Execute the command via the connection and return the results
-          connection.execute verb, path, params
+    def execute_request(verb, name, arguments)
+      parse_json(
+        execute_api_command(
+          verb,
+          get_path(arguments, get_action_name(name)),
+          get_params(arguments)
+        )
+      )
+    end
 
+    def method_missing(name, *arguments)
+      if check_function_name_valid name
+        verb = get_function_verb name
+        if verb
+          execute_request verb, name, arguments
         else
-          #Raise an exception based on the verb used is not correct
-          raise ArgumentError, 'Unsupported verb, functions should begin get_ post_ or delete_', caller
+          fail 'Invalid verb (get, post or delete supported)'
         end
-
       else
-        #Raise an exception based on the name of the function being incorrect
-        raise ArgumentError, 'Multiple underscores not allowed in function call', caller
+        fail 'Invalid function name'
       end
-
     end
-
   end
-
 end

data/lib/ServerPilot/version.rb

@@ -1,3 +1,4 @@
+# Gem version
 module ServerPilot
-  VERSION = '0.0.3'
+  VERSION = '0.0.4'
 end

metadata

@@ -1,29 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: ServerPilot
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Robert Coster
 autorequire: 
-bindir: bin
+bindir: exe
 cert_chain: []
-date: 2014-11-13 00:00:00.000000000 Z
+date: 2015-04-25 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.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '1.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '1.8'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -38,26 +52,28 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
-description: An API client gem to allow interaction from Ruby with the ServerPilot.io
-  API
+description: An API client for interaction with ServerPilot API
 email:
 - rob@signalfire.co.uk
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".autotest"
 - ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - ServerPilot.gemspec
+- bin/console
+- bin/setup
 - lib/ServerPilot.rb
-- lib/ServerPilot/connection.rb
 - lib/ServerPilot/version.rb
-homepage: http://www.signalfire.co.uk
-licenses:
-- MIT
+homepage: http://www.github.com/signalfire/serverpilot
+licenses: []
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -65,9 +81,9 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - "~>"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '2.1'
+      version: '2.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -75,8 +91,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
-summary: ServerPilot
+summary: An API client for interaction with ServerPilot API
 test_files: []

data/lib/ServerPilot/connection.rb

@@ -1,69 +0,0 @@
-require 'net/http'
-require 'uri'
-require 'json'
-require 'ostruct'
-
-module ServerPilot
-
-  class Connection
-
-    ENDPOINT = {
-        :scheme => 'https',
-        :host => 'api.serverpilot.io',
-        :port => 443
-    }
-
-    def initialize(api_client_id, api_key)
-      @sp_client_id = api_client_id
-      @sp_key = api_key
-    end
-
-    def create_uri(path)
-
-      URI::Generic.build({:scheme=>ENDPOINT[:scheme], :host=>ENDPOINT[:host], :path=>path, :port=>ENDPOINT[:port]})
-
-    end
-
-    def request(verb, path, params = nil)
-
-      uri = create_uri path
-
-      Net::HTTP.start(uri.host,uri.port,:use_ssl => true) do |http|
-
-        case verb.downcase
-          when 'get'
-            request = Net::HTTP::Get.new uri.path
-          when 'post'
-            request = Net::HTTP::Post.new uri.path, initheader = {'Content-Type' => 'application/json'}
-            request.body = params.to_json
-          when 'delete'
-            request = Net::HTTP::Delete.new uri.path
-        end
-
-        request.basic_auth @sp_client_id, @sp_key
-
-        http.request request
-
-      end
-
-    end
-
-    def parse_json(response)
-
-      body = JSON.parse(response.body)
-
-      OpenStruct.new(:code => response.code, :body => body)
-
-    end
-
-    def execute(verb, path, params = nil)
-
-      response = request(verb, path, params)
-
-      parse_json response
-
-    end
-
-  end
-
-end