bigpanda 0.1.0

data/lib/bigpanda.rb

@@ -0,0 +1 @@
+require 'bigpanda/bp-api'

data/lib/bigpanda/bp-api.rb

@@ -0,0 +1,134 @@
+require 'yaml'
+require 'json'
+require 'net/https'
+
+module BigPanda
+
+  VERSION               = '0.1.0'
+
+  DEFAULT_CONFIG_FILES  = [ "/etc/bigpanda.yaml", "/etc/bigpanda.yml" ]
+  DEFAULT_CONFIGURATION = { # overridable via the configuration file
+    :access_token          => nil,
+    :target_url            => 'https://api.bigpanda.io',
+    :deployment_start_path => '/data/events/deployments/start',
+    :deployment_end_path   => '/data/events/deployments/end'
+  }
+
+  #
+  # Main BigPanda API Class
+  #
+  # The client needs to be initialized with the access_token of the organization.
+  # Possible options:
+  # 1. Pass the access_token as a :access_token parameter
+  # 2. Place a bigpanda.yaml file in /etc/ and add to the file -  'access_token': YOUR_TOKEN
+  # 3. Pass a location of a yaml file using the :file parameter
+  #
+  #
+  class Client
+    attr_reader :config, :ssl
+
+    def initialize(options = {})
+
+      unless options.fetch(:access_token, nil)
+        file = options.delete(:file)
+        file_config, config_files = read_config_from_file(file)
+        options.merge!(file_config) if file_config
+      end
+
+      @config = DEFAULT_CONFIGURATION.merge(options)
+      @ssl = options.delete(:ssl) || {}
+
+      unless @config.fetch(:access_token, nil)
+        raise "No BigPanda config token received, and no configuration file found. Searched: #{config_files.join ','}."
+      end
+    end
+
+    def deployment_start(options = {})
+      return deployment_notification config[:deployment_start_path], options
+    end
+
+    def deployment_end(options = {})
+      return deployment_notification config[:deployment_end_path], options
+    end
+
+    private
+
+      class Error < RuntimeError; end
+      class Unauthorized < RuntimeError; end
+
+      # Prepare the call to BigPanda API and send a HTTP Request
+      #
+      def deployment_notification(path, options)
+        place_default_values(options)
+
+        return request path, JSON.generate(options)
+      end
+
+      # Perform the actual request to BigPanda API
+      #
+      def request(path, body, target_url = config[:target_url])
+        headers  = { 'Accept' => 'application/json',
+                     'Content-Type' => 'application/json',
+                     'Authorization' => "Bearer #{config[:access_token]}" }
+
+        uri = URI.parse(target_url)
+        h = Net::HTTP.new uri.host, uri.port
+        h.set_debug_output $stderr if $DEBUG
+        h.use_ssl = (uri.scheme.downcase == 'https')
+
+        set_ssl_overrides(h)
+
+        h.start do |http|
+          response = http.request_post path, body, headers
+          raise Unauthorized if response.code.to_i == 401
+          raise Error, "server error: #{response.body}" if response.code.to_i >= 500
+
+          answer = JSON.load(response.body)['response']
+          raise Error, answer['errors'].join(", ") if response.code.to_i >= 400
+
+          return answer
+        end
+      end
+
+      def place_default_values(options)
+        options[:timestamp] = options.fetch(:timestamp, Time.now.utc.to_i) # unix time
+
+        if options.has_key?(:hosts)
+          options[:hosts] = options[:hosts].kind_of?(Array) ? options[:hosts] : [options[:hosts]]
+        end
+      end
+
+      # Read configuration from the default list of configuration files and the received file.
+      #
+      # Returns the the found configuration and the list of files which were used.
+      #
+      def read_config_from_file(file)
+
+        config_files = ([file] + DEFAULT_CONFIG_FILES).compact
+        config = nil
+
+        config_files.each do |config_file|
+          if File.exists? config_file
+            config = YAML.load_file(config_file)
+
+            # Convert string keys to symbols
+            config.keys.each do |key|
+              config[(key.to_sym rescue key) || key] = config.delete(key)
+            end
+          end
+        end
+
+        return config, config_files
+      end
+
+      def set_ssl_overrides(http)
+        http.certificate  = ssl[:client_cert]  if ssl[:client_cert]
+        http.private_key  = ssl[:client_key]   if ssl[:client_key]
+        http.ca_file      = ssl[:ca_file]      if ssl[:ca_file]
+        http.ssl_version  = ssl[:version]      if ssl[:version]
+        http.verify_mode  = ssl[:verify_mode]  if ssl[:verify_mode]
+      end
+
+    end
+end
+

data/lib/bigpanda/capistrano.rb

@@ -0,0 +1,81 @@
+require 'bigpanda'
+
+Capistrano::Configuration.instance(:must_exist).load do |config|
+
+  namespace :bigpanda do
+
+    desc '[Internal] Notifies BigPanda that a deployment has started'
+    task :notify_deploy_started do
+      transaction do
+        on_rollback do
+          notify_deploy_failed
+        end
+
+        send_deployment_start
+      end
+    end
+
+    desc '[Internal] Notifies BigPanda that a deployment has finished successfuly'
+    task :notify_deploy_finished do
+      send_deployment_end('success')
+    end
+
+    desc '[Internal] Notifies BigPanda that a deployment has finished with an error'
+    task :notify_deploy_failed do
+      send_deployment_end('failure', errorMessage: 'failed to deploy')
+    end
+
+  end
+
+  # Map capistrano execution variables to BigPanda Fields for deployment start
+  #
+  # == Parameters:
+  #  optional Hash which can contain all propriatery fields
+  #
+  def send_deployment_start(properties = {})
+    panda = create_bigpanda_client
+
+    panda.deployment_start({:component => application,
+                            :version => "#{fetch(:branch, '')} #{release_name}",
+                            :hosts => find_servers_for_task(current_task),
+                            :env => rails_env,
+                            :owner => fetch(:bp_owner, nil),
+                            :properties => properties
+                            })
+  rescue Exception => e
+    logger.important "err :: while sending BigPanda start, Skipping to next command. #{e.message}"
+  end
+
+  # Map capistrano execution variables to BigPanda Fields for deployment end
+  #
+  # == Parameters:
+  #  optional Hash which can contain all propriatery fields
+  #
+  def send_deployment_end(status, properties = {})
+    panda = create_bigpanda_client
+
+    errorMessage = properties.delete(:errorMessage)
+
+    panda.deployment_end({ :component => application,
+                           :version => "#{fetch(:branch, '')} #{release_name}",
+                           :hosts => find_servers_for_task(current_task),
+                           :status => status,
+                           :env => rails_env,
+                           :errorMessage => errorMessage,
+                           :properties => properties})
+  rescue Exception => e
+    logger.important "err :: while sending BigPanda start, Skipping to next command. #{e.message}"
+  end
+
+
+  def create_bigpanda_client
+    BigPanda::Client.new(:access_token => fetch(:bigpanda_access_token, nil))
+  end
+
+
+  # Hooks:
+  #   Wrap deploy execution
+
+  before "deploy:update_code", "bigpanda:notify_deploy_started"
+  after  "deploy", "bigpanda:notify_deploy_finished"
+end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification
+name: bigpanda
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- BigPanda
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A Ruby client (and additional integrations) for BigPanda's API
+email: support@bigpanda.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/bigpanda.rb
+- lib/bigpanda/capistrano.rb
+- lib/bigpanda/bp-api.rb
+homepage: https://github.com/bigpandaio/bigpanda-rb
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: A Ruby client (and additional integrations) for BigPanda's API
+test_files: []