travis-client 0.1.0

data/.gitignore

@@ -0,0 +1,2 @@
+Gemfile.lock
+*.gem

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,9 @@
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - ree
+  - rbx
+  - jruby
+  - ruby-head
+

data/Gemfile

@@ -0,0 +1,4 @@
+source :gemcutter
+
+gemspec
+

data/README.textile

@@ -0,0 +1,111 @@
+h1. Travis Ruby Client - "!https://secure.travis-ci.org/travis-ci/travis-ruby-client.png?branch=master!":http://travis-ci.org/travis-ci/travis-ruby-client
+
+h2. Contact
+* "Github":http://github.com/travis-ci/travis-ruby-client
+* "Twitter":http://twitter.com/travisci
+* "IRC":irc://irc.freenode.net#travis
+* "Mailinglist":http://groups.google.com/group/travis-ci
+
+h2. Documentation
+
+* "YARD docs":http://rdoc.info/github/travis-ci/travis-ruby-client/master/file/README.textile
+
+h2. Usage [As a Command Line Tool]
+
+<pre>
+Supported Commands:
+    travis repositories|repos|repo|r {options}
+    travis status|stat|s {options}
+
+Repositories:
+    travis status|stat|s
+    travis repositories|repos|repo|r [--recent]
+    travis repositories --slugs={repository_slug}[,{repository_slug}[,...]]
+    travis repositories --name={repository_name} --owner={owner_name}
+    travis repositories --slug={repository_slug}
+    travis repositories --builds
+    travis repositories --name={repository_name} --owner={owner_name} --build_id={build_id}
+    travis repositories --slug={repository_slug} --build_id={build_id}
+
+Supported Options:
+    --recent                         lists the recent processed repositories.
+    -B, --builds                     lists the recent builds for a repository.
+    -o, --owner=                     sets the target repository owner's name.
+    -n, --name=                      sets the target repository name.
+    -s, --slug=                      sets the target repositorys slug.
+    -S, --slugs=                     sets the target repositories slugs (comma separated).
+    -b, --build_id=                  sets the target repository build id.
+    -h, -H, --help                   display this help message.
+</pre>
+
+The `status` command should be run from your project directory. It will try to identify and dispaly the Travis status of the target repository based on the current directory remote git urls.
+
+h2. Usage [As a Ruby Library]
+
+h3. Fetching Repositories
+
+<pre>
+Travis::API::Client::Repositories.all #Collection of Repository instances
+
+Travis::API::Client::Repositories.all! #Collection of Repository instances bypassing cache
+
+Travis::API::Client::Repositories.owner('owner_name_here').name('name_here').fetch #Repository
+
+Travis::API::Client::Repositories.owner('owner_name_here').name('name_here').fetch! #Repository bypassing cache
+
+Travis::API::Client::Repositories.slug('owner_name_here/name_here').fetch #Repository
+
+Travis::API::Client::Repositories.slug('owner_name_here/name_here').fetch! #Repository bypassing cache
+</pre>
+
+h3. Fetching Builds
+
+<pre>
+Travis::API::Client::Repositories.owner('owner_name_here').name('name_here').builds #Collection of Build instances 
+
+Travis::API::Client::Repositories.owner('owner_name_here').name('name_here').builds! #Collection of Build instances bypassing cache
+
+Travis::API::Client::Repositories.slug('owner_name_here/name_here').builds #Collection of Build instances
+
+Travis::API::Client::Repositories.slug('owner_name_here/name_here').builds! #Collection of Build instances bypassing cache
+
+Travis::API::Client::Repositories.owner('owner_name_here').name('name_here').build('id_here') #Build
+
+Travis::API::Client::Repositories.owner('owner_name_here').name('name_here').build!('id_here') #Build bypassing cache
+
+Travis::API::Client::Repositories.slug('owner_name_here/name_here').build('id_here') #Build
+
+Travis::API::Client::Repositories.slug('owner_name_here/name_here').build!('id_here') #Build bypassing cache
+</pre>
+
+h3. Repository methods
+
+The main attributes from the API will be accessible via the following methods:
+
+bc. [:slug, :id, :status, :last_build_id, :last_build_status, :last_build_number, :last_build_finished_at]
+
+Some relationships can be retrieved using the following methods:
+
+bc. repository.builds #=> Collection of Build instances
+repository.last_build #=> Build
+
+You can also update the repository information from the API usign:
+
+bc. repository.reload! #=> Fetch the updated repository data from the API and updates its attributes and relationships
+
+h3. Build methods
+
+The main attributes from the API will be accessible via the following methods:
+
+bc. [:number, :commited_at, :commit, :finished_at, :config, :author_name, :log, :branch, :id, :parent_id, :started_at, :author_email, :status, :repository_id, :message, :compare_url]
+
+Some relationships can be retrieved using the following methods:
+
+bc. build.parent #=> Build or nil
+build.repository #=> Repository
+build.matrix #=> Collection of Build instances or nil
+    
+You can also update the build information from the API usign:
+
+bc. build.reload! #=> Fetch the updated build data from the API and updates its attributes and relationships
+

data/Rakefile

@@ -0,0 +1,8 @@
+require 'cucumber/rake/task'
+require 'rspec/core/rake_task'
+
+Cucumber::Rake::Task.new(:cucumber) 
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => [:spec, :cucumber]

data/bin/travis

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+$LOAD_PATH << './lib/'
+require 'travis/client'
+
+available_commands = ['repositories', 'status']
+
+command = ARGV.first.to_s.downcase
+
+if !available_commands.include?(command) && available_commands.select {|c| c =~ Regexp.new("^#{command}.*")}.length == 1
+  command = available_commands.detect {|c| c =~ Regexp.new("^#{command}.*")}
+end
+
+if ['repositories'].include?(command)
+  Travis::Client.const_get(command.capitalize).new.run
+elsif ['status'].include?(command)
+  Travis::Client.send(command)
+else
+  ARGV << '-h'
+  Travis::Client.new.run
+end
+ 

data/features/repositories.feature

@@ -0,0 +1,117 @@
+Feature: Repositories
+  In order to get informatio about the Travis CI repoisitories
+  As ruby application
+  I want to get the the repositories information through the API wrapper
+
+  Scenario Outline: Get all repositories
+    Given I am using the Travis::API::Client::Repositories client
+    When I request <method>
+    Then I should get a collection of Travis::API::Entity::Repository instances
+  
+  Examples:
+    |method |
+    |all    |
+    |all!   |
+
+  Scenario Outline: Get a repository by name and owner
+    Given I am using the Travis::API::Client::Repositories client
+    When I set the name to "travis-ci"
+    And I set the owner to "travis-ci"
+    And I request <method>
+    Then I should get a Travis::API::Entity::Repository
+    And the result should have the following values:
+      | name  | travis-ci           |
+      | owner | travis-ci           |
+      | slug  | travis-ci/travis-ci |
+    And the result should have the following numeric values:
+      | id    | 59                  |
+
+  Examples:
+    |method |
+    |fetch  |
+    |fetch! |
+
+# Right now there's no way to get a repository directly by id.
+#
+# We are iterating over the recent repositories trying to find the target repo by id.
+#
+# It will fail most of the times since the recent repositories is a really small list.
+#
+# Looking forward for an API call to get repos by id or at list one to get all the repos and 
+# not just the recent ones.
+#
+#  Scenario Outline: Get a repository by name and owner
+#    Given I am using the Travis::API::Client::Repositories client
+#    When I set the id to "59"
+#    And I request <method>
+#    Then I should get a Travis::API::Entity::Repository
+#    And the result should have the following values:
+#      | name  | travis-ci           |
+#      | owner | travis-ci           |
+#      | slug  | travis-ci/travis-ci |
+#    And the result should have the following numeric values:
+#      | id    | 59                  |
+#
+#  Examples:
+#    |method |
+#    |fetch  |
+#    |fetch! |
+#
+
+  Scenario Outline: Get a repository by name and owner
+    Given I am using the Travis::API::Client::Repositories client
+    When I set the slug to "travis-ci/travis-ci"
+    And I request <method>
+    Then I should get a Travis::API::Entity::Repository
+    And the result should have the following values:
+      | name  | travis-ci           |
+      | owner | travis-ci           |
+      | slug  | travis-ci/travis-ci |
+    And the result should have the following numeric values:
+      | id    | 59                  | 
+
+  Examples:
+    |method |
+    |fetch  |
+    |fetch! |
+
+  Scenario Outline: Get the builds from a repository
+    Given I am using the Travis::API::Client::Repositories client
+    When I set the owner to "travis-ci"
+    And I set the name to "travis-ci"
+    And I request <method>
+    Then I should get a collection of Travis::API::Entity::Build instances
+
+  Examples:
+    |method  |
+    |builds  |
+    |builds! |
+
+  Scenario Outline: Get a build from a repository by id
+    Given I am using the Travis::API::Client::Repositories client
+    When I set the owner to "travis-ci"
+    And I set the name to "travis-ci"
+    And I request <method> with the following params:
+      |69619 |
+    Then I should get a Travis::API::Entity::Build
+    And the result should have the following values:
+      | author_email  | svenfuchs@artweb-design.de                                                      |
+      | author_name   | Sven Fuchs                                                                      |
+      | branch        | statemachine                                                                    |
+      | commit        | 04beda102abcb37b353e406663535d2bc2c4da5c                                        |
+      | committed_at  | 2011-08-07T00:03:40Z                                                            |
+      | compare_url   | https://github.com/travis-ci/travis-ci/compare/5878605...04beda1                |
+      | finished_at   | 2011-08-07T00:18:36Z                                                            | 
+      | message       | Merge branch 'statemachine' of github.com:travis-ci/travis-ci into statemachine |
+      | number        | 772                                                                             |
+      | started_at    | 2011-08-07T00:14:41Z                                                            |
+    And the result should have the following numeric values:
+      | id            | 69619                                                                           |
+      | repository_id | 59                                                                              |
+      | status        | 1                                                                               |
+    And the result should respond to "matrix" with a collection of Travis::API::Entity::Build instances
+    And the result should respond to "repository" with a Travis::API::Entity::Repository instances
+  Examples:
+    |method |
+    |build  |
+    |build! |

data/features/step_definitions/repositories_steps.rb

@@ -0,0 +1,51 @@
+Given /^I am using the ((?:\:?{2}\w+)+) client$/ do |class_name|
+  @client = class_name.split('::').inject(Object) {|x,y| x = x.const_get(y)}    
+end
+
+Then /^I should get a collection of ((?:\:?{2}\w+)+) instances$/ do |class_name|
+  expected_class = class_name.split('::').inject(Object) {|x,y| x = x.const_get(y)}
+  @result.each do |element|
+    element.should be_instance_of expected_class
+  end
+end
+
+When /^I set the (\w+) to "([^"]*)"$/ do |method, value|
+  @client = @client.send(method, value)
+end
+
+Then /^I should get a ((?:\:?{2}\w+)+)$/ do |class_name|
+  @result.should be_instance_of class_name.split('::').inject(Object) {|x,y| x = x.const_get(y)}
+end
+
+Then /^the result should have the following values:$/ do |table|
+  table.rows_hash.each_pair do |key, value|
+    @result.send(key).should == value
+  end
+end
+
+Then /^the result should have the following numeric values:$/ do |table|
+  table.rows_hash.each_pair do |key, value|
+    @result.send(key).should == value.to_f
+  end
+end
+
+When /^I request (\w+\!?)$/ do |method|
+  @result = @client.send(method)
+end
+
+When /^I request (\w+\!?) with the following params:$/ do |method, table|
+  @result = @client.send(method, *table.raw.collect(&:first))
+end
+
+Then /^the result should respond to "([^"]*)" with a collection of ((?:\:?{2}\w+)+) instances$/ do |method, class_name|
+  expected_class = class_name.split('::').inject(Object) {|x,y| x = x.const_get(y)}
+  @result.send(method).each do |element|
+    element.should be_instance_of expected_class
+  end
+end
+
+Then /^the result should respond to "([^"]*)" with a ((?:\:?{2}\w+)+) instances$/ do |method, class_name|
+  expected_class = class_name.split('::').inject(Object) {|x,y| x = x.const_get(y)}
+  @result.send(method).should be_instance_of expected_class
+end
+

data/features/support/env.rb

@@ -0,0 +1,2 @@
+require File.dirname(__FILE__) + '/../../lib/travis.rb'
+require File.dirname(__FILE__) + '/../../lib/travis/client.rb'

data/lib/travis.rb

@@ -0,0 +1,2 @@
+require 'travis/api'
+

data/lib/travis/api.rb

@@ -0,0 +1,3 @@
+require 'travis/api/client'
+require 'travis/api/entity'
+

data/lib/travis/api/client.rb

@@ -0,0 +1,95 @@
+require 'net/http'
+require 'json'
+require 'faraday'
+require 'travis/api/client/repositories'
+
+module Travis
+
+  module API
+
+    # Travis API Client
+
+    class Client
+
+      def initialize(options = {})
+        @options = {:format => DEFAULT_FORMAT}.merge(options)
+      end
+
+      # Sets the response format and returns the host client instance
+      #
+      # @param [Symbol, String] format The desired response format, <tt>:json</tt>.
+      # @return [Client, Client::Repositories] The host client instance.
+      def format(format)
+        @options[:format] = format.to_s
+        self
+      end
+
+      def self.method_missing(method, *args, &block)
+        return self.new.send(method, *args, &block) if self.client.respond_to?(method)
+        super
+      end
+
+      def self.respond_to?(method, include_private = false)
+        self.client.respond_to?(method, include_private) || super(method, include_private)
+      end	
+
+    private
+       
+      # Client default host
+      API_HOST = 'http://travis-ci.org'
+
+      # Response default format
+      DEFAULT_FORMAT = 'json'
+
+      # Returns the HTTP connection handler
+      #
+      # @return [Faraday] 
+      def connection
+        @@connection ||= Faraday.new(:url => API_HOST) do |builder|
+          builder.adapter  :net_http
+        end
+      end
+     
+      # Returns the encoded response for the given path and previouly set options
+      #
+      # @param [String] path API target path
+      # @return Encoded response
+      def results_for(path_template)
+        path = path_template.dup
+
+        @options.each_pair do |key, value|
+          path.gsub!(":#{key}", value)
+        end
+
+        response = connection().get(path)
+        
+        return response.status == 200 ? parse(response.body) : nil
+      end
+
+      # Encodes and return the given content based on the previously set format
+      #
+      # @param [String] content Content to be encoded
+      # @return Encoded conter
+      def parse(content)
+        case @options[:format]
+        when 'json' then
+          return JSON.parse(content)
+        when 'xml'
+          return REXML::Document.new(content)
+        end
+      end
+
+ 
+      # Initializes and return an instance of the current class
+      #
+      # @return A new instance of the current class
+      def self.client
+        self.new
+      end
+
+    end
+
+  end
+
+end
+

data/lib/travis/api/client/repositories.rb

@@ -0,0 +1,234 @@
+module Travis
+
+  module API
+  
+    class Client
+      
+      # Travis API Client for Repositories 
+
+      class Repositories < Client
+
+        # Returns the cached list of repositories or fetches the 
+        # recent list if there's nothing already cached.
+        # 
+        # @return [Array<Entity::Repository>] 
+        def all
+          #Having some issues with the cached repositories
+          #@@repositories || self.all!
+          self.all!
+        end    
+
+        # Fetches and return the list of recent repositories.
+        # It also updates the repositorires cache.
+        #
+        # @return [Array<Entity::Repository>]
+        def all!
+          @@repositories = results_for(REPOSITORIES_PATH).map {|repository_data| Entity::Repository.new(repository_data)}
+        end
+
+        # Returns a repository from the cache or fetches it 
+        # based on the previously set options (name and owner or slug or id).
+        #
+        # @return [Entity::Repository]
+        def fetch
+          #Having some issues with the cached repositories
+          #fetch_from_cache() || self.fetch!
+          self.fetch!
+        end
+
+        # Fetches and return a repository based on the previously 
+        # set options (name and owner or slug or id).
+        # It also adds this repository to the repositories cache.
+        #
+        # @return [Entity::Repository]
+        def fetch!
+          repository = @options[:id] ? fetch_by_id!() : fetch_by_owner_and_name!() 
+          repositories_cache() << repository
+          repository
+        end
+
+        # Returns the cached list of builds or fetches the 
+        # recent list if there's nothing already cached.
+        #
+        # @return [Array<Entity::Build>]
+        def builds
+          #Having some issues with the cahced builds
+          #@@builds || self.builds!
+          self.builds!
+        end
+
+        # Fetches and return the list of recent builds.
+        # It also updates the builds cache.
+        #
+        # @return [Array<Entity::Build>]
+        def builds!
+          @@builds = results_for(REPOSITORY_BUILDS_PATH).map {|build_data| Entity::Build.new(build_data, @options[:owner], @options[:name])}
+        end
+     
+        # Returns a build from the cache or fetches it 
+        # based on the given build id and the previously set 
+        # options (name and owner or slug or id).
+        #
+        # @return [Entity::Build]
+        def build(build_id)
+          #Having some issues with the cached builds
+          #build_from_cache(build_id) || self.build!(build_id) 
+          self.build!(build_id)
+        end
+
+        # Fetches and return a build based on the given
+        # build id and the previously set options (name and owner or
+        # slug or id).
+        # It also adds this build to the builds cache.
+        #
+        # @return [Entity::Build]
+        def build!(build_id)
+          @options[:build_id] = build_id.to_s
+          builds_cache().delete_if {|b| b.id == @options[:build_id]}
+          build = Entity::Build.new(results_for(REPOSITORY_BUILD_PATH), @options[:owner], @options[:name])
+          builds_cache() << build
+          build
+        end
+
+        # Sets the target repository id and return the host client instance.
+        # @param [Fixnum, String] id The target repository id.
+        # @return [Client::Repositories] The host client instance.
+        def id(id)
+          @options[:id] = id
+          self
+        end
+        
+        # Sets the target repository owner and return the host client instance.
+        # @param [String] owner The target repository owner.
+        # @return [Client::Repositories] The host client instance.
+        def owner(owner)
+          @options[:owner] = owner
+          self
+        end    
+
+        # Sets the target repository name and return the host client instance.
+        # @param [String] name The target repository name.
+        # @return [Client::Repositories] The host client instance.
+        def name(name)
+          @options[:name] = name
+          self
+        end
+
+        # Sets the target repository slug and return the host client instance.
+        # @param [String] slug The target repository slug.
+        # @return [Client::Repositories] The host client instance.  
+        def slug(slug)
+          @options[:owner], @options[:name] = slug.split('/')
+          self
+        end
+
+        # Twick to accept `self.name(param)` as class method. It won't
+        # raise the NoMethodError but an ArgumentError so we can not
+        # apply reflection.
+        # Sice we are polite programmers the class still respond to the
+        # `self.name()` class method
+        #
+        # Creates an instance of the client, sets the target repository
+# name and returns the host client instance.
+        #
+        # @param [String] name The target repository name.
+
+        # @return [Client::Repositories] The host client instance.
+        def self.name(name = nil)
+          return super unless name
+          self.new.name(name)
+        end
+
+      private
+
+        # API Path template for a repository
+        REPOSITORY_PATH        = '/:owner/:name.:format'
+
+        # API Path template for the repository listing
+        REPOSITORIES_PATH      = '/repositories.:format'
+
+        # API Path template for a repository build
+        REPOSITORY_BUILD_PATH  = '/:owner/:name/builds/:build_id.:format'
+       
+        # API Path template for the repository build listing
+        REPOSITORY_BUILDS_PATH = '/:owner/:name/builds.:format'
+
+        # Cached repositories
+        # @return [Array<Entity::Repository>, NilClass] 
+        @@repositories = nil
+
+        # Cached builds
+        # @return [Array<Entity::Build>, NilClass]
+        @@builds = nil
+
+        # Returns the cached collection of repositories
+        # or an empty array if it was not initialized yet.
+        #
+        # @return [Array<Entity::Repository>, NilClass]
+        def repositories_cache
+          @@repositories || []
+        end
+
+        # Returns the cached collection of builds
+        # or an empty array if it was not initialized yet.
+        #
+        # @return [Array<Entity::Build>, NilClass]
+        def builds_cache
+          @@builds || []
+        end
+
+        # Fetches and returns a repository based on the
+        # owner and name option values.
+        #
+        # @return [Entity::Repository]
+        def fetch_by_owner_and_name!
+          repositories_cache().delete_if {|r| r.owner == @options[:owner] && r.name == @options[:name]}
+          repository_data = results_for(REPOSITORY_PATH)
+          return repository_data && Entity::Repository.new(repository_data, @options[:owner], @options[:name])
+        end
+
+        # Right now there's no way to get a repository directly by id.
+        #
+        # Iterates over the recent repositories trying to find the target repo by id.
+        #
+        # It will fail most of the times since the recent repositories is a really small list.
+        # Looking forward for an API call to get repos by id or at list one to get all the repos and 
+        # not just the recent ones.
+        #
+        # Fetches and returns a repository based the id option value.
+        # If the Repository can not be found an exception will be rised.
+        #
+        # @return [Entity::Repository]
+        def fetch_by_id!
+          repositories_cache().delete_if {|r| r.id == @options[:id]}
+          return self.all!.find {|r| r.id == @options[:id]} || raise("Repository not found: id => #{@options[:id]}")
+        end
+
+        # Looks into the cache for a repository, based on the previously set
+        # id or name and owner, returning the repository or nil if it's not present.
+        #
+        # @return [Entity::Repository, NilClass]
+        def fetch_from_cache
+          if @options[:id]
+            repositories_cache().find {|repository| repository.id == @options[:id].to_i}
+          else
+            repositories_cache().find {|repository| repository.owner == @options[:owner] && repository.name == @options[:name]}
+          end
+        end
+
+        # Looks into the cache for a build, based on the given build id,
+        # returning the build or nil if it's not present.
+        #
+        # @return [Entity::Build, NilClass]
+        def build_from_cache(build_id)
+          builds_cache().find {|build| build.id == build_id.to_s} 
+        end
+
+      end
+
+    end
+
+  end
+
+end
+