deployhq 1.0.0

data/lib/deploy.rb

@@ -0,0 +1,34 @@
+require 'rubygems'
+require 'bundler'
+Bundler.setup
+
+require 'json'
+require 'uri'
+require 'net/http'
+require 'net/https'
+require 'time'
+
+## DeployHQ Ruby API Client
+## This is a ruby API library for the DeployHQ deployment platform.
+
+require 'deploy/errors'
+require 'deploy/request'
+require 'deploy/base'
+
+require 'deploy/project'
+require 'deploy/deployment'
+require 'deploy/server'
+
+
+module Deploy
+  VERSION = '1.0.0'
+  
+  class << self
+    ## Domain which you wish to access (e.g. atech.deployhq.com)
+    attr_accessor :site
+    ## E-Mail address you wish to authenticate with
+    attr_accessor :email
+    ## API key for the user you wish to authenticate with
+    attr_accessor :api_key
+  end
+end

data/lib/deploy/base.rb

@@ -0,0 +1,166 @@
+module Deploy
+  class Base
+    
+    ## Store all attributes for the model we're working with.
+    attr_accessor :id, :attributes, :errors
+    
+    ## Pass any methods via. the attributes hash to see if they exist
+    ## before resuming normal method_missing behaviour
+    def method_missing(method, *params)
+      set = method.to_s.include?('=')
+      key = method.to_s.sub('=', '')
+      self.attributes = Hash.new unless self.attributes.is_a?(Hash)
+      if set
+        self.attributes[key] = params.first
+      else
+        self.attributes[key]
+      end
+    end
+    
+    class << self
+      
+      ## Find a record or set of records. Passing :all will return all records and passing an integer
+      ## will return the individual record for the ID passed.
+      def find(type, params = {})
+        case type
+        when :all then find_all(params)
+        else find_single(type, params)
+        end
+      end
+      
+      ## Find all objects and return an array of objects with the attributes set.
+      def find_all(params)
+        output = JSON.parse(Request.new(collection_path(params)).make.output)
+        if output.is_a?(Hash) && output['records'] && output['pagination']
+          output = output['records']
+        end
+        return [] unless output.is_a?(Array)
+        output.map do |o|
+          create_object(o, params)
+        end
+      end
+      
+      ## Find a single object and return an object for it.
+      def find_single(id, params = {})
+        o = JSON.parse(Request.new(member_path(id, params)).make.output)
+        if o.is_a?(Hash)
+          create_object(o, params)
+        else
+          raise Deploy::Errors::NotFound, "Record not found"
+        end
+      end
+      
+      ## Post to the specified object on the collection path
+      def post(path)
+        Request.new(path.to_s, :post).make
+      end
+      
+      ## Return the collection path for this model. Very lazy pluralizion here
+      ## at the moment, nothing in Deploy needs to be pluralized with anything
+      ## other than just adding an 's'.
+      def collection_path(params = {})
+        class_name.downcase + 's'
+      end
+      
+      ## Return the member path for the passed ID & attributes
+      def member_path(id, params = {})
+        [collection_path, id].join('/')
+      end
+      
+      ## Return the deploy class name
+      def class_name
+        self.name.to_s.split('::').last.downcase
+      end
+      
+      private
+            
+      ## Create a new object with the specified attributes and getting and ID. 
+      ## Returns the newly created object
+      def create_object(attributes, objects = [])
+        o = self.new
+        o.attributes = attributes
+        o.id         = attributes['id']
+        for key, object in objects.select{|k,v| v.kind_of?(Deploy::Base)}
+          o.attributes[key.to_s] = object
+        end
+        o
+      end
+    end
+    
+    ## Run a post on the member path. Returns the ouput from the post, false if a conflict or raises
+    ## a Deploy::Error. Optionally, pass a second 'data' parameter to send data to the post action.
+    def post(action, data = nil)
+      path = self.class.member_path(self.id, default_params) + "/" + action.to_s
+      request = Request.new(path, :post)
+      request.data = data
+      request.make
+    end
+    
+    ## Delete this record from the remote service. Returns true or false depending on the success
+    ## status of the destruction.
+    def destroy
+      Request.new(self.class.member_path(self.id, default_params), :delete).make.success?
+    end
+    
+    def new_record?
+      self.id.nil?
+    end
+    
+    def save
+      new_record? ? create : update
+    end
+
+    def create
+      request = Request.new(self.class.collection_path(default_params), :post)
+      request.data = {self.class.class_name.downcase.to_sym => attributes_to_post}
+      if request.make && request.success?
+        new_record = JSON.parse(request.output)
+        self.attributes = new_record
+        self.identifier = new_record['identifier']
+        true
+      else
+        populate_errors(request.output)
+        false
+      end
+    end
+
+    ## Push the updated attributes to the remote. Returns true if the record was saved successfully
+    ## other false if not. If not saved successfully, the errors hash will be updated with an array
+    ## of all errors with the submission.    
+    def update
+      request = Request.new(self.class.member_path(self.id, default_params), :put)
+      request.data = {self.class.class_name.downcase.to_sym => attributes_to_post}
+      if request.make && request.success?
+        true
+      else
+        populate_errors(request.output)
+        false
+      end
+    end
+    
+    private
+    
+    ## Populate the errors hash from the given raw JSON output
+    def populate_errors(json)
+      self.errors = Hash.new
+      JSON.parse(json).inject(self.errors) do |r, e|
+        r[e.first] = e.last
+        r
+      end
+    end
+    
+    ## An array of params which should always be sent with this instances requests
+    def default_params
+      Hash.new
+    end
+    
+    ## Attributes which can be passed for update & creation
+    def attributes_to_post
+      self.attributes.inject(Hash.new) do |r,(key,value)|
+        r[key] = value if value.is_a?(String) || value.is_a?(Integer) || value.is_a?(Fixnum)
+        r
+      end
+    end
+    
+  end
+end

data/lib/deploy/deployment.rb

@@ -0,0 +1,19 @@
+module Deploy
+  class Deployment < Base
+    
+    class << self
+      def collection_path(params = {})
+        "projects/#{params[:project].permalink}/deployments"
+      end
+      
+      def member_path(id, params = {})
+        "projects/#{params[:project].permalink}/deployments/#{id}"
+      end
+    end
+    
+    def default_params
+      {:project => self.project}
+    end
+    
+  end
+end

data/lib/deploy/errors.rb

@@ -0,0 +1,20 @@
+module Deploy
+  
+  ## Base level error which all other deploy errors will inherit from. It may also be
+  ## invoked for errors which don't directly relate to other errors below.
+  class Error < StandardError; end
+  
+  module Errors
+    
+    ## The service is currently unavailable. This may be caused by rate limiting or the API
+    ## or the service has been disabled by the system
+    class ServiceUnavailable < Error; end
+    
+    ## Access was denied to the remote service
+    class AccessDenied < Error; end
+    
+    ## A communication error occured while talking to the Deploy API
+    class CommunicationError < Error; end
+        
+  end
+end

data/lib/deploy/project.rb

@@ -0,0 +1,49 @@
+module Deploy
+  class Project < Base
+    
+    ## Return all deployments for this project
+    def deployments
+      Deployment.find(:all, :project => self)
+    end
+    
+    ## Return a deployment
+    def deployment(identifier)
+      Deployment.find(identifier, :project => self)
+    end
+    
+    ## Create a deployment in this project (and queue it to run)
+    def deploy(server, start_revision, end_revision)
+      run_deployment(server, start_revision, end_revision) do |d|
+        d.mode = 'queue'
+      end
+    end
+    
+    ##
+    def preview(server, start_revision, end_revision)
+      run_deployment(server, start_revision, end_revision) do |d|
+        d.mode = 'preview'
+      end
+    end
+
+    ## Return all servers for this project
+    def servers
+      Server.find(:all, :project => self)
+    end
+    
+    private
+    
+    def run_deployment(server, start_revision, end_revision, &block)
+      d = Deployment.new
+      d.project = self
+      d.server_identifier = (server.is_a?(Server) ? server.identifier : server)
+      d.start_revision = start_revision
+      d.end_revision = end_revision
+      d.copy_config_files = '1'
+      d.email_notify = '1'
+      block.call(d) if block_given?
+      d.save
+      d
+    end
+    
+  end
+end

data/lib/deploy/request.rb

@@ -0,0 +1,68 @@
+module Deploy
+  class Request
+    
+    attr_reader :path, :method
+    attr_accessor :data
+    
+    def initialize(path, method = :get)
+      @path = path
+      @method = method
+    end
+    
+    def success?
+      @success || false
+    end
+    
+    def output
+      @output || nil
+    end
+    
+    ## Make a request to the Deploy API using net/http. Data passed can be a hash or a string
+    ## Hashes will be converted to JSON before being sent to the remote service.
+    def make
+      uri = URI.parse([Deploy.site, @path].join('/'))
+      http_request = http_class.new(uri.path)
+      http_request.basic_auth(Deploy.email, Deploy.api_key)
+      http_request.add_field("Accept", "application/json")
+      http_request.add_field("Content-type", "application/json")
+      
+      http = Net::HTTP.new(uri.host, uri.port)
+      if uri.scheme == 'https'
+        http.use_ssl = true
+        http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      end
+      
+      data = self.data.to_json if self.data.is_a?(Hash) && self.data.respond_to?(:to_json)
+      http_result = http.request(http_request, data)
+      @output = http_result.body
+      @success = case http_result
+      when Net::HTTPSuccess
+        true
+      when Net::HTTPServiceUnavailable
+        raise Deploy::Errors::ServiceUnavailable
+      when Net::HTTPForbidden, Net::HTTPUnauthorized
+        raise Deploy::Errors::AccessDenied, "Access Denied for '#{Deploy.email}'"
+      when Net::HTTPNotFound
+        raise Deploy::Errors::CommunicationError, "Not Found at #{uri.to_s}"
+      when Net::HTTPClientError
+        false
+      else
+        raise Deploy::Errors::CommunicationError, http_result.body
+      end
+      self
+    end
+    
+    private
+    
+    def http_class  
+      case @method
+      when :post    then Net::HTTP::Post
+      when :put     then Net::HTTP::Put
+      when :delete  then Net::HTTP::Delete
+      else
+        Net::HTTP::Get
+      end
+    end
+    
+  end
+end

data/lib/deploy/server.rb

@@ -0,0 +1,19 @@
+module Deploy
+  class Server < Base
+    
+    class << self
+      def collection_path(params = {})
+        "projects/#{params[:project].permalink}/servers"
+      end
+      
+      def member_path(id, params = {})
+        "projects/#{params[:project].permalink}/servers/#{identifier}"
+      end
+    end
+    
+    def default_params
+      {:project => self.project}
+    end
+    
+  end
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification 
+name: deployhq
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Adam Cooke
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-08-24 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 4
+        - 6
+        version: 1.4.6
+  type: :runtime
+  version_requirements: *id001
+description: 
+email: adam@atechmedia.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/deploy/base.rb
+- lib/deploy/deployment.rb
+- lib/deploy/errors.rb
+- lib/deploy/project.rb
+- lib/deploy/request.rb
+- lib/deploy/server.rb
+- lib/deploy.rb
+has_rdoc: true
+homepage: http://www.deployhq.com
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: API client for the DeployHQ deployment platform
+test_files: []
+