ServerPilot 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 66cb9861282795741aadd7d9ce6d82804e7bf835
+  data.tar.gz: d922e0c149d2ff21b1a47efd4e2c505fad5cab0a
+SHA512:
+  metadata.gz: 35ade37164b91ec0763b04db0c34269110ac6f2b886bf6f50ee617f9fc98eb96dd6bd95614efc7c9a82263aeb01f6df0a5ce48e39fe851dc855e3bc153d4d601
+  data.tar.gz: e43399b08252874c5136e46544cc59ac56f494bd2023bb3dd66fc9af8722c260ec1cce2de3a8786a2fc5d8e5c7c14cdf52e777a59a23af57264a71c9df595153

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Robert Coster
+
+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,186 @@
+# ServerPilot
+
+ServerPilot
+===========
+
+Ruby client gem for accessing <a href="http://www.serverpilot.io" target="_blank">ServerPilot</a> API
+
+Install
+-------
+
+Install from RubyGems with **gem install serverpilot** or clone from this github
+
+Project on RubyGems at <a href="https://rubygems.org/gems/serverpilot" target="_blank">https://rubygems.org/gems/serverpilot</a>
+
+To create a connection **require 'serverpilot'**
+
+In your code add something like **sp = Signalfire::ServerPilot.new(client_id,key)**
+where client_id and key are your API information from ServerPilot.
+
+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'}
+
+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
+
+<table width="100%">
+<tr>
+<td><strong>Ruby Method</strong></td>
+<td><strong>Description</strong></td>
+<td><strong>Serverpilot API</strong></td>
+</tr>
+<tr>
+<td>[obj].get_servers</td>
+<td>Get a list of your servers</td>
+<td>GET /servers</td>
+</tr>
+<tr>
+<td>[obj].post_servers</td>
+<td>Connect a new server</td>
+<td>POST /servers</td>
+</tr>
+<tr>
+<td>[obj].get_servers [id]</td>
+<td>Retrieve existing server</td>
+<td>GET /servers/:id</td>
+</tr>
+<tr>
+<td>[obj].delete_servers [id]</td>
+<td>Delete a server</td>
+<td>DELETE /servers/:id</td>
+</tr>
+<tr>
+<td>[obj].post_servers [id] [params]</td>
+<td>Update a server</td>
+<td>POST /server/:id</td>
+</tr>
+<tr>
+<td>[obj].get_sysusers</td>
+<td>List all system users</td>
+<td>GET /sysusers</td>
+</tr>
+<tr>
+<td>[obj].post_sysusers [params]</td>
+<td>Create new system user</td>
+<td>POST /sysusers</td>
+</tr>
+<tr>
+<td>[obj].get_sysusers [id]</td>
+<td>Retrieve existing user</td>
+<td>GET /sysusers/:id</td>
+</tr>
+<tr>
+<td>[obj].delete_sysusers [id]</td>
+<td>Delete a system user</td>
+<td>DELETE /sysusers/:id</td>
+</tr>
+<tr>
+<td>[obj].post_sysusers [id] [params]</td>
+<td>Update the password of a system user</td>
+<td>POST /sysusers/:id</td>
+</tr>
+<tr>
+<td>[obj].get_apps</td>
+<td>List all apps</td>
+<td>GET /apps</td>
+</tr>
+<tr>
+<td>[obj].post_apps [params]</td>
+<td>Create an app</td>
+<td>POST /apps</td>
+</tr>
+<tr>
+<td>[obj].get_apps [id]</td>
+<td>Retrieve app</td>
+<td>GET /apps/:id</td>
+</tr>
+<tr>
+<td>[obj].delete_apps [id]</td>
+<td>Delete an app</td>
+<td>DELETE /apps/:id</td>
+</tr>
+<tr>
+<td>[obj].post_apps [id] [params]</td>
+<td>Update an app</td>
+<td>POST /apps/:id</td>
+</tr>
+<tr>
+<td>[obj].post_ssl [id] [params]</td>
+<td>Add an SSL</td>
+<td>POST /apps/:id/ssl</td>
+</tr>
+<tr>
+<td>[obj].delete_ssl [id]</td>
+<td>Delete an SSL</td>
+<td>DELETE /apps/:id/ssl</td>
+</tr>
+<tr>
+<td>[obj].get_dbs</td>
+<td>Get databases</td>
+<td>GET /dbs</td>
+</tr>
+<tr>
+<td>[obj].post_dbs [params]</td>
+<td>Create a new database</td>
+<td>POST /dbs</td>
+</tr>
+<tr>
+<td>[obj].get_dbs [id]</td>
+<td>Retrieve existing db</td>
+<td>GET /dbs/:id</td>
+</tr>
+<tr>
+<td>[obj].delete_dbs [id]</td>
+<td>Delete a database</td>
+<td>DELETE /dbs/:id</td>
+</tr>
+<tr>
+<td>[obj].post_dbs [id] [params]</td>
+<td>Update the database user password</td>
+<td>POST /dbs/:id</td>
+</tr>
+<tr>
+<td>[obj].get_actions [id]</td>
+<td>Get status of action</td>
+<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'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ServerPilot
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/signalfire/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`)
+5. Create a new Pull Request

data/Rakefile

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

data/ServerPilot.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ServerPilot/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'ServerPilot'
+  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.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.required_ruby_version = '~> 2.1'
+
+end

data/lib/ServerPilot.rb

@@ -0,0 +1,106 @@
+require 'ServerPilot/version'
+require 'ServerPilot/connection'
+
+module ServerPilot
+
+  class API
+
+    def initialize(api_client_id, api_key)
+
+      @sp_client_id = api_client_id
+
+      @sp_key = api_key
+
+    end
+
+    def build_path(action, id = nil)
+
+      if action === 'ssl'
+
+        ['/v1', 'apps', id, 'ssl'] * '/'
+
+      else
+
+        if id
+          ['/v1', action, id] * '/'
+        else
+          ['/v1', 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
+
+            end
+
+          end
+
+          #Create a new connection
+          connection = ServerPilot::Connection.new(@sp_client_id, @sp_key)
+
+          #Execute the command via the connection and return the results
+          connection.execute verb, path, params
+
+        else
+          #Raise an exception based on the verb used is not correct
+          raise ArgumentError, 'Unsupported verb, functions should begin get_ post_ or delete_', caller
+        end
+
+      else
+        #Raise an exception based on the name of the function being incorrect
+        raise ArgumentError, 'Multiple underscores not allowed in function call', caller
+      end
+
+    end
+
+  end
+
+end

data/lib/ServerPilot/connection.rb

@@ -0,0 +1,69 @@
+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

data/lib/ServerPilot/version.rb

@@ -0,0 +1,3 @@
+module ServerPilot
+  VERSION = '0.0.3'
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: ServerPilot
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+platform: ruby
+authors:
+- Robert Coster
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: An API client gem to allow interaction from Ruby with the ServerPilot.io
+  API
+email:
+- rob@signalfire.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- ServerPilot.gemspec
+- lib/ServerPilot.rb
+- lib/ServerPilot/connection.rb
+- lib/ServerPilot/version.rb
+homepage: http://www.signalfire.co.uk
+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.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: ServerPilot
+test_files: []