semaphoreapp 0.1.0

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
+.rvmrc

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Alessandro Morandi
+
+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,105 @@
+# Semaphoreapp
+
+A Ruby client for the Semaphore API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'semaphoreapp'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install semaphoreapp
+
+## Configuration
+
+To use the [Semaphore API](http://docs.semaphoreapp.com/api), you need an `auth_token`. You can find your token through the Semaphore web interface.
+
+To configure the gem with your token, add a line such as:
+
+```ruby
+Semaphoreapp.auth_token = 'Yds3w6o26FLfJTnVK2y9'
+```
+
+The token will be cached, so you will only need to set it once.
+
+## Usage
+
+### Projects
+
+To get all the projects associated with your auth token:
+
+```ruby
+projects = Semaphoreapp::Project.all
+```
+
+To get a specific project (based on its name):
+
+```ruby
+project = Semaphoreapp::Project.find_by_name('testapp-sphinx')
+```
+
+Once you have a project, you can get all its branches:
+
+```ruby
+project.get_branches
+```
+
+Note that, due to the way the API works, the following call will return all the branch *statuses* for a given project:
+
+```ruby
+project.branches
+```
+
+### Branches
+
+Note that all the class methods for `Branch` require the hash id of the project to be passed in as a parameter (`3f1004b8343faabda63d441734526c854380ab89` in the examples below).
+
+To get a specific branch (based on its name):
+
+```ruby
+branch = Semaphoreapp::Branch.find_by_name('3f1004b8343faabda63d441734526c854380ab89', 'master')
+```
+
+Once you have a branch, you can get its current status:
+
+```ruby
+branch.get_status
+```
+
+or its build history:
+
+```ruby
+branch.get_builds
+```
+
+## Object model
+
+The gem uses classes to represent objects returned by API calls. The classes are:
+
+* `Project`: a project Semaphore is running CI for. It may have many `BranchStatus` objects.
+* `BranchStatus`: the status of a branch in a project. It may have a `Commit` object.
+* `Branch`: a branch in a project.
+* `Build`: a CI build. It may have a `Commit` object.
+* `Commit`: a Git commit.
+
+## Tests
+
+To run all the specs for this project:
+
+```bash
+$ rake
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/semaphoreapp/api.rb

@@ -0,0 +1,75 @@
+module Semaphoreapp
+  class Api
+    class Error < RuntimeError; end
+
+    BASE_URL = 'https://semaphoreapp.com'
+    API_URL = 'api/v1'
+
+    def self.get_projects(options={})
+      set_auth_token(options)
+      send_request(projects_url).body
+    end
+
+    def self.get_branches(project_hash_id, options={})
+      set_auth_token(options)
+      send_request(branches_url(project_hash_id)).body
+    end
+
+    def self.get_branch_history(project_hash_id, id, options={})
+      set_auth_token(options)
+      response = send_request(branch_history_url(project_hash_id, id, options))
+      return response.body, response['pagination']
+    end
+
+    def self.get_branch_status(project_hash_id, id, options={})
+      set_auth_token(options)
+      send_request(branch_status_url(project_hash_id, id)).body
+    end
+
+    def self.projects_url
+      url_with_auth_token("#{API_URL}/projects")
+    end
+
+    def self.branches_url(project_hash_id)
+      url_with_auth_token("#{API_URL}/projects/#{project_hash_id}/branches")
+    end
+
+    def self.branch_history_url(project_hash_id, id, options={})
+      url_with_auth_token("#{API_URL}/projects/#{project_hash_id}/#{id}", options)
+    end
+
+    def self.branch_status_url(project_hash_id, id)
+      url_with_auth_token("#{API_URL}/projects/#{project_hash_id}/#{id}/status")
+    end
+
+    def self.url_with_auth_token(url, options={})
+      "/#{url}?auth_token=#{Semaphoreapp.auth_token}" << begin
+        options[:page].nil? ? '' : "&page=#{options[:page]}"
+      end
+    end
+
+
+    private
+
+    def self.send_request url
+      https = setup_https(BASE_URL)
+      https.start do |session|
+        puts url if Semaphoreapp.debug?
+        req = Net::HTTP::Get.new(url)
+        session.request(req)
+      end
+    end
+
+    def self.setup_https(endpoint)
+      url   = URI.parse(endpoint)
+      https = Net::HTTP.new(url.host, url.port)
+      https.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      https.use_ssl = true
+      return https
+    end
+
+    def self.set_auth_token(options)
+      Semaphoreapp.auth_token = options[:auth_token] unless options[:auth_token].nil?
+    end
+  end
+end

data/lib/semaphoreapp/base.rb

@@ -0,0 +1,28 @@
+module Semaphoreapp
+  class Base < OpenStruct
+
+    def self.build(source, *params)
+      if source.is_a?(Hash)
+        build_from_hash(source, *params)
+      elsif source.is_a?(Array)
+        build_from_array(source, *params)
+      end
+    end
+
+
+    private
+
+    def self.build_from_hash(source_hash, &block)
+      self.new(
+        source_hash.dup.tap do |hash|
+          block.call(hash) unless block.nil?
+        end
+      )
+    end
+
+    def self.build_from_array(source_array, *params)
+      source_array.map{ |source_item| self.build_from_hash(source_item, *params) }
+    end
+
+  end
+end

data/lib/semaphoreapp/branch.rb

@@ -0,0 +1,44 @@
+module Semaphoreapp
+  class Branch < Base
+
+    def get_status
+      Semaphoreapp::BranchStatus.build( Semaphoreapp::JsonApi.get_branch_status(project_hash_id, id) )
+    end
+
+    # The only supported option is ':page => <number>', with <number> defaulting to 1 if not present“
+    def get_builds(options={})
+      history = Semaphoreapp::JsonApi.get_branch_history(project_hash_id, id, options)
+      Semaphoreapp::Build.build(history['builds'])
+    end
+
+    def self.find(project_hash_id, branch_id)
+      all_by_project_hash_id(project_hash_id).find{ |branch| branch.id.to_s == branch_id.to_s }
+    end
+
+    def self.find_by_name(project_hash_id, name)
+      all_by_project_hash_id(project_hash_id).find{ |branch| branch.name == name }
+    end
+
+    def self.find_master(project_hash_id)
+      find_by_name(project_hash_id, 'master')
+    end
+
+    def self.all_by_project_hash_id(project_hash_id)
+      build(Semaphoreapp::JsonApi.get_branches(project_hash_id), project_hash_id)
+    end
+
+    def self.build(source, project_hash_id)
+      super(source, project_hash_id)
+    end
+
+
+    private
+
+    def self.build_from_hash(branch, project_hash_id)
+      super(branch) do |hash|
+        hash['project_hash_id'] = project_hash_id
+      end
+    end
+
+  end
+end

data/lib/semaphoreapp/branch_status.rb

@@ -0,0 +1,14 @@
+module Semaphoreapp
+  class BranchStatus < Base
+
+
+    private
+
+    def self.build_from_hash(branch_status)
+      super do |hash|
+        hash['commit'] = Semaphoreapp::Commit.build(hash['commit'])
+      end
+    end
+
+  end
+end

data/lib/semaphoreapp/build.rb

@@ -0,0 +1,13 @@
+module Semaphoreapp
+  class Build < Base
+
+    private
+
+    def self.build_from_hash(build)
+      super do |hash|
+        hash['commit'] = Semaphoreapp::Commit.build(hash['commit'])
+      end
+    end
+
+  end
+end

data/lib/semaphoreapp/commit.rb

@@ -0,0 +1,5 @@
+module Semaphoreapp
+  class Commit < Base
+
+  end
+end

data/lib/semaphoreapp/json_api.rb

@@ -0,0 +1,33 @@
+module Semaphoreapp
+  class JsonApi < Api
+    def self.get_projects(options={})
+      raise_if_error(JSON.parse(super))
+    end
+
+    def self.get_branches(project_hash_id, options={})
+      raise_if_error(JSON.parse(super))
+    end
+
+    def self.get_branch_history(project_hash_id, id, options={})
+      # require "pry"; binding.pry
+      raise_if_error(parse(*super))
+    end
+
+    def self.get_branch_status(project_hash_id, id, options={})
+      raise_if_error(JSON.parse(super))
+    end
+
+
+    private
+
+    def self.raise_if_error(obj, pagination=nil)
+      raise Semaphoreapp::Api::Error, obj['error'] if obj.is_a?(Hash) && obj.has_key?('error')
+      return obj, pagination
+    end
+
+    def self.parse(body, pagination)
+      require "pry"; binding.pry
+      PaginatedArray.new(JSON.parse(pagination), JSON.parse(body))
+    end
+  end
+end

data/lib/semaphoreapp/project.rb

@@ -0,0 +1,34 @@
+module Semaphoreapp
+  class Project < Base
+
+    def get_branches
+      Semaphoreapp::Branch.all_by_project_hash_id(hash_id)
+    end
+
+    def master_branch_status
+      branches.find{ |branch_status| branch_status.branch_name == 'master'}
+    end
+
+    def self.all
+      build(Semaphoreapp::JsonApi.get_projects)
+    end
+
+    def self.find(project_hash_id)
+      all.find{ |project| project.hash_id == project_hash_id }
+    end
+
+    def self.find_by_name(name)
+      all.find{ |project| project.name == name }
+    end
+
+
+    private
+
+    def self.build_from_hash(project)
+      super do |hash|
+        hash['branches'] = Semaphoreapp::BranchStatus.build(hash['branches'])
+      end
+    end
+
+  end
+end

data/lib/semaphoreapp/version.rb

@@ -0,0 +1,3 @@
+module Semaphoreapp
+  VERSION = "0.1.0"
+end

data/lib/semaphoreapp.rb

@@ -0,0 +1,38 @@
+require 'net/http'
+require 'net/https'
+require 'openssl'
+require 'uri'
+require 'json'
+require 'ostruct'
+
+require "semaphoreapp/api"
+require "semaphoreapp/base"
+require "semaphoreapp/branch"
+require "semaphoreapp/branch_status"
+require "semaphoreapp/build"
+require "semaphoreapp/commit"
+require "semaphoreapp/json_api"
+require "semaphoreapp/paginated_array"
+require "semaphoreapp/project"
+require "semaphoreapp/version"
+
+module Semaphoreapp
+  @@debug = false
+
+  def self.auth_token= auth_token
+    @@auth_token = auth_token
+  end
+
+  def self.auth_token
+    @@auth_token
+  end
+
+  def self.debug= debug
+    @@debug = debug
+  end
+
+  def self.debug?
+    @@debug
+  end
+
+end

data/semaphoreapp.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/semaphoreapp/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Alessandro Morandi"]
+  gem.email         = ["webmaster@simbul.net"]
+  gem.description   = %q{A client for the Semaphore API}
+  gem.summary       = %q{A client for the Semaphore API}
+  gem.homepage      = "http://github.com/Simbul/semaphoreapp"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "semaphoreapp"
+  gem.require_paths = ["lib"]
+  gem.version       = Semaphoreapp::VERSION
+
+  gem.add_runtime_dependency 'json'
+
+  gem.add_development_dependency 'awesome_print'
+  gem.add_development_dependency 'pry'
+  gem.add_development_dependency 'pry-debugger'
+  gem.add_development_dependency 'rspec'
+end

data/spec/fixtures/branch_statuses.json

@@ -0,0 +1,42 @@
+[
+  {
+    "branch_name": "master",
+    "branch_url": "http://10.0.1.76:3000/projects/61/branches/85",
+    "branch_status_url": "http://semaphoreapp.com/api/v1/projects/3f1004b8343faabda63d441734526c854380ab89/85/status?auth_token=Yds3w6o26FLfJTnVK2y9",
+    "branch_history_url": "http://semaphoreapp.com/api/v1/projects/3f1004b8343faabda63d441734526c854380ab89/85?auth_token=Yds3w6o26FLfJTnVK2y9",
+    "project_name": "testapp-sphinx",
+    "build_url": "http://10.0.1.76:3000/projects/61/branches/85/builds/1",
+    "build_number": 1,
+    "result": "passed",
+    "started_at": "2012-09-04T11:55:07Z",
+    "finished_at": "2012-09-04T12:01:16Z",
+    "commit": {
+      "id": "a31d32d5de89613369f934eb7d30fbeb08883334",
+      "url": "https://github.com/renderedtext/base-app/commit/a31d32d5de89613369f934eb7d30fbeb08883334",
+      "author_name": "Vladimir Saric",
+      "author_email": "vladimir@renderedtext.com",
+      "message": "Update 'shoulda' gem.",
+      "timestamp": "2012-10-02T07:00:14Z"
+    }
+  },
+  {
+    "branch_name": "testbranch",
+    "branch_url": "http://10.0.1.76:3000/projects/61/branches/86",
+    "branch_status_url": "http://semaphoreapp.com/api/v1/projects/3f1004b8343faabda63d441734526c854380ab89/86/status?auth_token=Yds3w6o26FLfJTnVK2y9",
+    "branch_history_url": "http://semaphoreapp.com/api/v1/projects/3f1004b8343faabda63d441734526c854380ab89/86?auth_token=Yds3w6o26FLfJTnVK2y9",
+    "project_name": "testapp-sphinx",
+    "build_url": "http://10.0.1.76:3000/projects/61/branches/86/builds/1",
+    "build_number": 1,
+    "result": "failed",
+    "started_at": "2012-09-05T11:55:07Z",
+    "finished_at": "2012-09-05T12:01:16Z",
+    "commit": {
+      "id": "73fce130ad23f265add5d55ee1da1c23b38f85a4",
+      "url": "https://github.com/renderedtext/base-app/commit/73fce130ad23f265add5d55ee1da1c23b38f85a4",
+      "author_name": "Marko Anastasov",
+      "author_email": "marko@renderedtext.com",
+      "message": "Update 'factory_girl_rails' gem and use new short FactoryGirl syntax.",
+      "timestamp": "2012-10-02T07:00:14Z"
+    }
+  }
+]

data/spec/fixtures/branches.json

@@ -0,0 +1,14 @@
+[
+  {
+    "id": 1324,
+    "name": "new-build-page"
+  },
+  {
+    "id": 1120,
+    "name": "development"
+  },
+  {
+    "id": 987,
+    "name": "branches_api"
+  }
+]

data/spec/fixtures/builds.json

@@ -0,0 +1,32 @@
+[
+  {
+    "build_url": "http://semaphoreapp.com/projects/57/branches/80/builds/46",
+    "build_number": 46,
+    "result": "failed",
+    "started_at": "2012-10-02T15:01:41Z",
+    "finished_at": "2012-10-02T15:03:53Z",
+    "commit": {
+      "id": "a31d32d5de89613369f934eb7d30fbeb08883334",
+      "url": "https://github.com/renderedtext/base-app/commit/a31d32d5de89613369f934eb7d30fbeb08883334",
+      "author_name": "Vladimir Saric",
+      "author_email": "vladimir@renderedtext.com",
+      "message": "Update 'shoulda' gem.",
+      "timestamp": "2012-10-02T07:00:14Z"
+    }
+  },
+  {
+    "build_url": "http://semaphoreapp.com/projects/57/branches/80/builds/45",
+    "build_number": 45,
+    "result": "passed",
+    "started_at": "2012-10-02T14:47:06Z",
+    "finished_at": "2012-10-02T14:51:35Z",
+    "commit": {
+      "id": "73fce130ad23f265add5d55ee1da1c23b38f85a4",
+      "url": "https://github.com/renderedtext/base-app/commit/73fce130ad23f265add5d55ee1da1c23b38f85a4",
+      "author_name": "Marko Anastasov",
+      "author_email": "marko@renderedtext.com",
+      "message": "Update 'factory_girl_rails' gem and use new short FactoryGirl syntax.",
+      "timestamp": "2012-10-02T07:00:14Z"
+    }
+  }
+]

data/spec/fixtures/commit.json

@@ -0,0 +1,8 @@
+{
+  "id": "dc395381e650f3bac18457909880829fc20e34ba",
+  "url": "https://github.com/renderedtext/base-app/commit/dc395381e650f3bac18457909880829fc20e34ba",
+  "author_name": "Vladimir Saric",
+  "author_email": "vladimir@renderedtext.com",
+  "message": "Update 'shoulda' gem.",
+  "timestamp": "2012-07-04T18:14:08Z"
+}

data/spec/fixtures/projects.json

@@ -0,0 +1,46 @@
+[
+  {
+    "id": 61,
+    "hash_id": "3f1004b8343faabda63d441734526c854380ab89",
+    "name": "testapp-sphinx",
+    "owner": "renderedtext",
+    "created_at": "2012-09-04T11:53:22Z",
+    "updated_at": "2012-09-04T12:01:17Z",
+    "branches": [
+      {
+        "branch_name": "master",
+        "branch_url": "http://10.0.1.76:3000/projects/61/branches/85",
+        "branch_status_url": "http://semaphoreapp.com/api/v1/projects/3f1004b8343faabda63d441734526c854380ab89/85/status?auth_token=Yds3w6o26FLfJTnVK2y9",
+        "branch_history_url": "http://semaphoreapp.com/api/v1/projects/3f1004b8343faabda63d441734526c854380ab89/85?auth_token=Yds3w6o26FLfJTnVK2y9",
+        "project_name": "testapp-sphinx",
+        "build_url": "http://10.0.1.76:3000/projects/61/branches/85/builds/1",
+        "build_number": 1,
+        "result": "passed",
+        "started_at": "2012-09-04T11:55:07Z",
+        "finished_at": "2012-09-04T12:01:16Z"
+      }
+    ]
+  },
+  {
+    "id": 63,
+    "hash_id": "649e584dc507ca4b73e1374d3125ef0b567a949c",
+    "name": "testapp-mongodb",
+    "owner": "renderedtext",
+    "created_at": "2012-09-14T10:53:38Z",
+    "updated_at": "2012-09-14T11:16:51Z",
+    "branches": [
+      {
+        "branch_name": "mongoid3",
+        "branch_url": "http://10.0.1.76:3000/projects/63/branches/89",
+        "branch_status_url": "http://semaphoreapp.com/api/v1/projects/3f1004b8343faabda63d441734526c854380ab89/85/status?auth_token=Yds3w6o26FLfJTnVK2y9",
+        "branch_history_url": "http://semaphoreapp.com/api/v1/projects/3f1004b8343faabda63d441734526c854380ab89/85?auth_token=Yds3w6o26FLfJTnVK2y9",
+        "project_name": "testapp-mongodb",
+        "build_url": "http://10.0.1.76:3000/projects/63/branches/89/builds/3",
+        "build_number": 3,
+        "result": "passed",
+        "started_at": "2012-09-14T11:11:39Z",
+        "finished_at": "2012-09-14T11:16:51Z"
+      }
+    ]
+  }
+]