travis-client 0.1.0

data/lib/travis/api/entity.rb

@@ -0,0 +1,44 @@
+require 'travis/api/entity/repository'
+require 'travis/api/entity/build'
+
+module Travis
+
+  module API
+
+     # Travis API element representation
+
+    class Entity
+
+      # @param [Hash{String=>String,Fixnum}] attributes
+      def initialize(attributes = {})
+        @attributes = attributes
+      end
+
+      # Any of the attributes elements previously set on the initialization
+      # will be accessible via its analog method.
+      #
+      # Example:
+      #    Entity.new({:something => 'Hey There!'}).something #=> 'Hey There!'
+      def method_missing(method, *args, &block)
+        return @attributes[method.to_s] if @attributes.has_key?(method.to_s)
+        super
+      end
+
+      # Adds the attributes elements to the list of methods that
+      # the Entity will respond to.
+      def respond_to?(method, include_private=false)
+        @attributes.has_key?(method.to_s) || super(method, include_private)
+      end	
+
+    protected 
+     
+      def attributes
+        @attributes
+      end
+   
+    end
+
+  end
+
+end
+

data/lib/travis/api/entity/build.rb

@@ -0,0 +1,129 @@
+module Travis
+
+  module API
+    
+    class Entity
+
+      # Travis API Build representation 
+
+      class Build < Entity
+      
+        # @param [Hash{String=>String,Fixnum}] attributes
+        # @param [String, NilClass] repository_owner The repository owner's name
+        # @param [String, NilClass] repository_name The repository's name
+        def initialize(attributes = {}, repository_owner = nil, repository_name = nil)
+          @repository_owner = repository_owner
+          @repository_name = repository_name
+          super(attributes)
+        end
+        
+        # Returns the hash representation of the Build
+        #
+        # @return [Hash{String=>String,Fixnum}]
+        def to_hash
+          return attributes()
+        end
+
+        # Fetches and returns the parent build based on the build {#partner_id}.
+        # Returns nil if the current buils is actually a parent.
+        # Once the parent is fetched it will remain cached until {#reload!} is called.
+        #  
+        # @return [Build, NilClass]
+        def parent
+          return nil if self.matrix
+          @parent ||= Client::Repositories.owner(repository_owner()).name(repository_name()).build!(self.partner_id)
+        end
+
+        # Fetches and returns its repository based on the build {#repository_id}.
+        # Once the repository is fetched it will remain cached until {#reload!} is called.
+        #
+        # @return [Repository]
+        def repository
+          @repository ||= repository!()
+        end
+
+        # Returns the collection of its children builds or nil if the current
+        # build is actually a child.
+        #
+        # @return [Array<Build>, NilClass]
+        def matrix
+          return nil unless @attributes.has_key?('matrix')
+          @matrix ||= @attributes['matrix'].map {|build_data| Build.new(build_data, repository_owner(), repository_name())}     
+        end
+
+        # Erases the cached results and updates its attributes.
+        #
+        # @return [Boolean]
+        def reload!
+          @repository = nil
+          @parent = nil
+          @matrix = nil
+          @attributes = Client::Repositories.owner(repository_owner()).name(repository_name()).build!(self.id).attributes
+          true
+        end
+
+        # Retrurns the build id
+        # We were forced to define this method since on ruby versions < 1.9.2
+        # {Object#id} is preventing the {Build#id} reflection.
+        #
+        # @return [Fixnum] Build ID
+        def id
+          @attributes['id']
+        end
+
+        # Returns its execution time
+        # We were forced to define this method since started_at may be not
+        # be present on the response, until the build starts its execution,
+        # causing an exception.
+        #
+        # @return [String,NilClass]
+        def started_at
+          @attributes['started_at']
+        end
+
+        # Returns its end of execution time
+        # We were forced to define this method since finished_at may be not
+        # be present on the response, until the build starts its execution,
+        # causing an exception.
+        #
+        # @return [String,NilClass]
+        def finished_at
+          @attributes['finished_at']
+        end
+
+      private
+
+        # Fetches its repository by name and owner. If any of them is 
+        # not present it will try to fetch the repository based on the {#repository_id}.
+        #
+        # @return [Repository]
+        def repository!
+          if @repository_owner && @repository_name
+            Client::Repositories.owner(@repository_owner).name(@repository_name).fetch! 
+          else
+            Client::Repositories.id(self.repository_id).fetch! 
+          end
+        end
+
+        # Returns the repository owner's name.
+        #
+        # @return [String]
+        def repository_owner
+          @repository_owner ||= self.repository.owner
+        end
+
+        # Returns the repository's name.
+        #
+        # @return [String]
+        def repository_name
+          @repository_name ||= self.repository.name
+        end
+
+      end
+
+    end
+
+  end
+
+end
+

data/lib/travis/api/entity/repository.rb

@@ -0,0 +1,79 @@
+module Travis
+
+  module API
+    
+    class Entity
+      
+      # Travis API Repository representation
+
+      class Repository < Entity
+        
+        # Repository's name
+        #
+        # @return [String, NilClass]
+        attr_reader :name
+
+        # Repository owner's name
+        #
+        # @return [String, NilClass]
+        attr_reader :owner
+
+        # @param [Hash{String=>String,Fixnum}] attributes
+        # @param [String, NilClass] name Repository's name
+        # @param [String, NilClass] owner Repository owner's name 
+        def initialize(attributes = {}, owner = nil, name = nil)
+          @owner = owner || attributes['slug'] && attributes['slug'].split('/').first
+          @name = name || attributes['slug'] && attributes['slug'].split('/').last
+          super(attributes)
+        end
+
+        # Returns the hash representation of the Repository
+        #
+        # @return [Hash{String=>String,Fixnum}]
+        def to_hash
+          return attributes()
+        end
+
+        # Fetches and returns its builds.
+        # Once the collection is fetched it will remain cached until {#reload!} is called.
+        #
+        # @return [Array<Build>]
+        def builds
+          @builds ||= Client::Repositories.owner(self.owner).name(self.name).builds!
+        end
+
+        # Fetches and returns its latest build.
+        # Once the build is fetched it will remain cached until {#reload!# is called.
+        #
+        # @return [Build]
+        def last_build
+          @last_build ||= Client::Repositories.owner(self.owner).name(self.name).build!(self.last_build_id)
+        end
+
+        # Erases the cached results and updates the repository attributes.
+        #
+        # @return [Boolean]
+        def reload!
+          @builds = nil
+          @last_build = nil
+          @attributes = Client::Repositories.owner(self.owner).name(self.name).fetch!.attributes
+          true
+        end
+       
+        # Retrurns the repository id
+        # We were forced to define this method since on ruby versions < 1.9.2
+        # {Object#id} is preventing the {Repository#id} reflection.
+        #
+        # @return [Fixnum] Repository ID
+        def id
+          @attributes['id']
+        end
+
+      end
+
+    end
+
+  end
+
+end
+

data/lib/travis/client.rb

@@ -0,0 +1,109 @@
+require 'ostruct'
+require 'optparse'
+require 'hirb'
+
+require 'travis/api'
+require 'travis/client/repositories'
+
+module Travis
+
+   # Travis Command Line Client
+
+  class Client
+
+    # Tries to guess the repository based on the git remote urls
+    # and prints its status.
+    # If several remote repositories are defined it will display
+    # the status of each of them. 
+    def self.status
+      ARGV[0] = 'repositories'
+      slugs = target_repository_slugs()
+      if slugs.length > 1
+        ARGV << "--slugs=#{target_repository_slugs().join(',')}"
+      else
+        ARGV << "--slug=#{target_repository_slugs().first}"
+      end
+      Repositories.new.run
+    end
+
+    # Handles the given options and executes the requested command 
+    def run
+      handle_options()
+      execute_operation()
+    end
+
+  private
+
+    # Returns the list of repository slugs based on the current 
+    # directory git remote repositories.
+    #
+    # @return [Array<String>]
+    def self.target_repository_slugs
+      %x[git remote -v].scan(/(?:\:|\/)([^\:\/]+\/[^\:\/]+)\.git/m).flatten.uniq
+    end
+
+    # Initializes and return the options as an OpenStruct instance
+    #
+    # @return [OpenStruct]
+    def options 
+      @options ||= OpenStruct.new
+    end
+
+    # Sets the options and creates the help layout.
+    def handle_options
+      OptionParser.new do |opts|
+        opts.banner = 'Travis CI Command Line Client'
+
+        setup_help(opts) {|opts|
+          opts.separator ''
+          opts.separator 'Supported Options:'
+          client_options().each {|option| opts.on(*option)}
+          opts.on_tail('--help', '-h', '-H', 'display this help message.') do
+            $stdout.print opts
+            exit
+          end
+        }
+      end.parse!
+    end
+   
+    # Sets up the custom help sections
+    #
+    # @param [OpenParser] opts The options parser
+    def setup_help(opts)
+      opts.separator ''
+      opts.separator <<-USAGE
+Usage:
+   travis repositories|repos|rep|r {options}
+   travis status|stat|s {options}
+      USAGE
+      opts.separator ''
+      opts.separator <<-FURTHER_HELP
+Furhter Help:
+    travis {command} --help
+      FURTHER_HELP
+
+      yield(opts)
+    end
+
+    # Retuns the default options
+    #
+    # @return [Array<String>]
+    def client_options 
+      []
+    end
+
+    # Starts the execution of the previousy requested
+    # command or rise and exception if the target operation
+    # to be executed can not be identified.
+    def execute_operation
+      unless options().target
+        raise 'Nothing to do ...'      
+      end
+
+      self.send(options().target)
+    end
+
+  end
+
+end
+

data/lib/travis/client/repositories.rb

@@ -0,0 +1,345 @@
+module Travis
+
+  class Client
+
+    # Travis Command Line Client for Repositories
+    class Repositories < Client
+
+      # Display a table with the list of the recent processed repositories
+      def recent
+        $stdout.print("Fetching recent repositories ...\n\n")
+        $stdout.print(repositories_table_for(API::Client::Repositories.all!))
+        $stdout.print("\n")
+      end
+
+      # Display detailed information of the requested repository
+      def fetch
+        $stdout.print("Fetching repository #{options().owner}/#{options().name} ...\n\n")
+        if repository = API::Client::Repositories.owner(options().owner).name(options().name).fetch!
+          $stdout.print(repository_view_for(repository))
+        else
+          $stdout.print("\033\[33mCould not find the #{options().owner}/#{options().name} repository.\033\[0m")
+        end
+        $stdout.print("\n")
+      end
+
+      # Display a table with the list of the requested repositories
+      def fetch_group
+        $stdout.print("Fetching repositories #{options().slugs.join(', ')} ...\n")
+        repositories = options().slugs.map {|slug| API::Client::Repositories.slug(slug).fetch! || $stdout.print("\033\[33mCould not find the #{slug} repository\033\[0m\n")}.compact
+        $stdout.print("\n")
+        $stdout.print(repositories_table_for(repositories))
+        $stdout.print("\n")
+      end
+
+      # Disaply a table with the list of recent proccessed repository builds
+      def builds
+        $stdout.print("Fetching #{options().owner}/#{options().name} builds ...\n\n")
+        if builds = API::Client::Repositories.owner(options().owner).name(options().name).builds!
+          $stdout.print(builds_table_for(builds))
+        else
+          $stdout.print("\033\[33mCould not find the #{options().owner}/#{options().name} repository.\033\[0m")
+        end
+        $stdout.print("\n")
+      end
+
+      # Display detailed information of the requested repository build
+      def build
+        $stdout.print("Fetching #{options().owner}/#{options().name} build ##{options().build_id} ...\n\n")
+        if build = API::Client::Repositories.owner(options().owner).name(options().name).build!(options().build_id)
+          $stdout.print(build_view_for(build))
+        else
+          $stdout.print("\033\[33mCould not find the #{options().owner}/#{options().name} build with ID = #{oprions().build_id}.\033\[0m")
+        end
+        $stdout.print("\n")
+      end
+
+    private
+ 
+      # Labels for the repository tables
+      # This also limits the information to be displayed. 
+      #
+      # @return [Array<String>] 
+      REPOSITORY_FIELDS = ['ID', 'Slug', 'Status', 'Started At', 'Finished At', 'Build ID', 'Build Number']
+
+      # Maps the repository attribute names with the table labels
+      #
+      # @return [Hash{String=>String}]
+      REPOSITORY_FIELD_NAMES = {
+        'id' => 'ID',
+        'slug' => 'Slug',
+        'last_build_status' => 'Status',
+        'last_build_started_at' => 'Started At',
+        'last_build_finished_at' => 'Finished At',
+        'last_build_id' => 'Build ID',
+        'last_build_number' => 'Build Number'
+      }
+
+      # Maps the status code from the API to its human translation.
+      #
+      # @return [Hash{NilClass,Fixnum=>String}]
+      BUILD_STATUS = {
+        nil => 'Running',
+        0   => 'Passing',
+        1   => 'Failing'
+      }
+      
+      # Maps the status code from the API to its human translation.
+      #
+      # @return [Hash]
+      BUILD_COLORED_STATUS = {
+        nil => "\033\[33mRunning\033\[0m",
+        0   => "\033\[32mPassing\033\[0m",
+        1   => "\033\[31mFailing\033\[0m"
+      }
+      
+      # Labels for the builds tables.
+      # This also limits the information to be displayed. 
+      #
+      # @return [Array<String>] 
+      BUILD_FIELDS = ['ID', 'Branch', 'Status', 'Started At', 'Finished At', 'Author', 'Commit', 'Repo ID']
+      
+      # Labels for the child builds tables.
+      # This also limits the information to be displayed. 
+      #
+      # @return [Array<String>] 
+      CHILD_BUILD_FIELDS = ['ID', 'Status', 'Started At', 'Finished At']
+
+      # Maps the build attribute names with the table labels
+      #
+      # @return [Hash{String=>String}]
+      BUILD_FIELD_NAMES = {
+        'id' => 'ID',
+        'branch' => 'Branch',
+        'status' => 'Status',
+        'started_at' => 'Started At',
+        'finished_at' => 'Finished At',
+        'author_name' => 'Author',
+        'commit' => 'Commit',
+        'message' => 'Message',
+        'compare_url' => 'Compare Url',
+        'repository_id' => 'Repo ID',
+        'number' => 'Numbre'
+      }
+
+      # Organize the present options and sets some defaults
+      def handle_options
+        set_default_options()
+        super
+      end
+
+      # Sets the default options
+      def set_default_options
+        options().target = :recent
+      end
+
+      # Sets up the custom sections of the help message
+      def setup_help(opts)
+        opts.separator ''
+        opts.separator <<-USAGE
+Commands: 
+   travis status|stat|s {options}
+   travis repositories|repos|repo|r {options}
+
+Usage:
+   travis status
+   travis repositories [--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}
+        USAGE
+
+        yield(opts)
+      end
+      
+      # Declares the list of available options that can be used.
+      #
+      # @return [Arrar<Array<String, Proc>>]
+      def client_options
+        super + [
+          ['--recent', 'lists the recent processed repositories.',
+            Proc.new {
+              options().target = :recent
+            }
+          ],
+          ['--builds', '-B', 'lists the recent builds for a repository.',
+            Proc.new { 
+              options().target = :builds
+            }
+          ],
+          ['--owner=', '-o', 'sets the target repository owner\'s name.',
+            Proc.new { |value|
+              options().target = :fetch
+              options().owner = value
+            }
+          ], 
+          ['--name=', '-n', 'sets the target repository name.',
+            Proc.new { |value|
+              options().target = :fetch
+              options().name = value
+            }
+          ], 
+          ['--slug=', '-s', 'sets the target repositorys slug.',
+            Proc.new { |value|
+              options().target = :fetch
+              owner, name = value.split('/')
+              options().owner = owner
+              options().name = name
+            }
+          ],
+          ['--slugs=', '-S', 'sets the target repositories slugs (comma separated).',
+            Proc.new { |value|
+              options().target = :fetch_group
+              options().slugs = value.split(',')
+            }
+          ],
+          ['--build_id=', '-b', 'sets the target repository build id.',
+            Proc.new { |value|
+              options().target = :build
+              options().build_id = value
+            }
+          ]
+        ]
+      end
+
+      # Returns the formatted view of a repository
+      #
+      # @return [String]
+      def repository_view_for(repository)
+        last_build = repository.last_build
+        <<-REPOSITORY
+#{repository.slug} - #{BUILD_COLORED_STATUS[repository.last_build_status]}
+
+Repository ID: #{repository.id}
+
+Last Build:
+  ID: #{last_build.id}
+  Number: #{last_build.number}
+
+  Started at: #{last_build.started_at ? DateTime.parse(last_build.started_at).strftime('%D %T'): '-----------------'}
+  Finished at: #{last_build.finished_at ? DateTime.parse(last_build.finished_at).strftime('%D %T'): '-----------------'}
+
+  Commit: #{last_build.commit[0...7]}(#{last_build.branch}) - http://github.com/#{repository.slug}/commit/#{last_build.commit[0...7]}
+  Author: #{last_build.author_name} (#{last_build.author_email})
+  Compare Url: #{last_build.compare_url}
+
+  Message: 
+     #{last_build.message.gsub("\n", "\n     ")}
+     #{last_build.matrix ? "\n  Build Matrix:\n    #{child_builds_table_for(last_build.matrix).gsub("\n", "\n    ")}": ''}
+        REPOSITORY
+      end
+
+      # Returns the formatted table of repositories
+      #
+      # @return [String]
+      def repositories_table_for(repositories)
+        Hirb::Helpers::Table.render(
+          repositories.map{|repo| repo.to_hash}, 
+          {
+            :description => false,
+            :fields => REPOSITORY_FIELDS, 
+            :change_fields => REPOSITORY_FIELD_NAMES,
+            :filters => {
+              'Status' => lambda { |status|
+                BUILD_STATUS[status]  
+              },
+              'Started At' => lambda { |started_at|
+                started_at ? DateTime.parse(started_at).strftime('%D %T') : '-----------------'
+              },
+              'Finished At' => lambda { |finished_at|
+                finished_at ? DateTime.parse(finished_at).strftime('%D %T') : '-----------------'
+              }
+            }
+          }
+        )
+      end
+      
+      # Returns the formatted table of builds
+      #
+      # @return [String]
+      def builds_table_for(builds)
+        Hirb::Helpers::Table.render(
+          builds.map{|build| build.to_hash}, 
+          {
+            :description => false,
+            :fields => BUILD_FIELDS, 
+            :change_fields => BUILD_FIELD_NAMES,
+            :max_fields => {
+              'Commit' => 10
+             },
+            :filters => {
+              'Status' => lambda { |status|
+                BUILD_STATUS[status]  
+              },
+              'Started At' => lambda { |started_at|
+                started_at ? DateTime.parse(started_at).strftime('%D %T') : '-----------------'
+              },
+              'Finished At' => lambda { |finished_at|
+                finished_at ? DateTime.parse(finished_at).strftime('%D %T') : '-----------------'
+              }
+            }
+          }
+        )
+      end
+      
+      # Returns the formatted table of builds
+      #
+      # @return [String]
+      def child_builds_table_for(builds)
+        Hirb::Helpers::Table.render(
+          builds.map{|build| build.to_hash}, 
+          {
+            :description => false,
+            :fields => CHILD_BUILD_FIELDS, 
+            :change_fields => BUILD_FIELD_NAMES,
+            :max_fields => {
+              'Commit' => 10
+             },
+            :filters => {
+              'Status' => lambda { |status|
+                BUILD_STATUS[status]  
+              },
+              'Started At' => lambda { |started_at|
+                started_at ? DateTime.parse(started_at).strftime('%D %T') : '-----------------'
+              },
+              'Finished At' => lambda { |finished_at|
+                finished_at ? DateTime.parse(finished_at).strftime('%D %T') : '-----------------'
+              }
+            }
+          }
+        )
+      end
+
+      # Returns the formatted view of a build
+      #
+      # @return [String]
+      def build_view_for(build)
+        <<-BUILD
+#{build.repository.slug} - #{BUILD_COLORED_STATUS[build.status]}
+
+ID: #{build.id}
+Number: #{build.number}
+Repository ID: #{build.repository.id}
+
+Started at: #{build.started_at ? DateTime.parse(build.started_at).strftime('%D %T'): '-----------------'}
+Finished at: #{build.finished_at ? DateTime.parse(build.finished_at).strftime('%D %T'): '-----------------'}
+
+Commit: #{build.commit[0...7]}(#{build.branch}) - http://github.com/#{build.repository.slug}/commit/#{build.commit[0...7]}
+Author: #{build.author_name} (#{build.author_email})
+Compare Url: #{build.compare_url}
+
+Message: 
+   #{build.message.gsub("\n", "\n   ")}
+   #{build.matrix ? "\nBuild Matrix:\n#{child_builds_table_for(build.matrix)}": ''}
+        BUILD
+      end
+
+    end
+
+  end
+  
+end
+