singularity_client 0.2.0 → 0.3.0

data/README.md

@@ -18,10 +18,11 @@ Or install it yourself as:
 
 ## Configuration
 
-The singularity client configures itself off a `.singularity.yml` file.
+Configuration options may be declared from the command line,
+or defined in a `.singularity.yml` file.
 
 By default, the tool will start looking for a `.singularity.yml` in your current working directory,
-and will work its way up to the root directory. Specify a path via the `--config` command line option.
+and will work its way up to the root directory. Specify a file via the `--config` command line option.
 
 ### Available configurations:
 
@@ -30,24 +31,28 @@ and will work its way up to the root directory. Specify a path via the `--config
     <th>Key</th>
     <th>Description</th>
     <th>Type</th>
+    <th>Required</th>
     <th>Example</th>
   </tr>
   <tr>
     <td><tt>singularity_url</tt></td>
     <td>URL for the singularity server</td>
     <td>String</td>
+    <td>Yes</td>
     <td><tt>'http://singularity.net'</tt></td>
   </tr>
   <tr>
     <td><tt>singularity_port</tt></td>
     <td>Port the singularity server is operating on</td>
     <td>String</td>
+    <td>Yes</td>
     <td><tt>'9000'</tt></td>
   </tr>
   <tr>
     <td><tt>github_organization</tt></td>
     <td>Default github organization to use</td>
     <td>String</td>
+    <td>No</td>
     <td><tt>'Behance'</tt></td>
   </tr>
 </table>

data/lib/singularity_client/api.rb

@@ -17,8 +17,15 @@ module SingularityClient
       pp(JSON.parse(response.body))
     end
 
-    def self.add(config, repo, project)
-      endpoint = 'config/pull_request'
+    ##
+    # Add to the singularity config
+    # the 'type' parameter can be pull_request or push
+    #
+    def self.add(config, repo, project, type)
+      # This is just to maintain backwards compatability
+      type ||= 'pull_request'
+
+      endpoint = (type == 'push') ? 'config/push' : 'config/pull_request'
       post_data = {
         organization: config.organization,
         repo: repo,

data/lib/singularity_client/cli.rb

@@ -10,7 +10,7 @@ module SingularityClient
 
     def initialize(*args)
       super
-      @config_hash = SingularityClient::Config.new(options)
+      @cli_options = options
     end
 
     # rubocop:disable AlignHash
@@ -25,21 +25,44 @@ module SingularityClient
 
     desc 'config', 'Get the current singularity config object'
     def config
-      SingularityClient::API.config(config_hash)
+      run(:config)
     end
 
     desc 'add REPO_NAME PROJECT_NAME', 'Add a github repository to singularity'
+    long_desc 'This will add both pull requests, and pushes, to singularity'
     method_option :github_organization, aliases: '-o', type: :string,
       desc: 'Override the default github organization'
     def add(repo, project)
-      SingularityClient::API.add(config_hash, repo, project)
+      run(:add, repo, project, 'pull_request')
+      run(:add, repo, project, 'push')
+    end
+
+    desc 'addPull REPO_NAME PROJECT_NAME', 'Add repo pulls to singularity'
+    method_option :github_organization, aliases: '-o', type: :string,
+      desc: 'Override the default github organization'
+    def add_pull(repo, project)
+      run(:add, repo, project, 'pull_request')
+    end
+
+    desc 'addPush REPO_NAME PROJECT_NAME', 'Add repo pushes to singularity'
+    method_option :github_organization, aliases: '-o', type: :string,
+      desc: 'Override the default github organization'
+    def add_push(repo, project)
+      run(:add, repo, project, 'push')
     end
 
     desc 'comment REPO_NAME PR_NUM COMMENT', 'Write comment to a pull request'
     method_option :github_organization, aliases: '-o', type: :string,
       desc: 'Override the default github organization'
     def comment(repo, pr, comment)
-      SingularityClient::API.comment(config_hash, repo, pr, comment)
+      run(:comment, repo, pr, comment)
+    end
+
+    private
+
+    def run(action, *args)
+      config = SingularityClient::Config.new(@cli_options)
+      SingularityClient::API.send(action, config, *args)
     end
   end
 end

data/lib/singularity_client/config.rb

@@ -6,16 +6,15 @@ require 'pathname'
 module SingularityClient
   # Wrapper around the config object
   class Config
-    DOTFILE = '.singularity.yml'
-
     attr_accessor :options
 
-    def initialize(inputs)
-      config_file = inputs['config'] || find_config_file('.')
-      @options = load_from_file(config_file).merge(inputs)
+    def initialize(inputs = {})
+      @options = ConfigLoader.load_from_file(inputs['config'], inputs['debug'])
+      @options = @options.merge(inputs)
 
-      puts "DEBUG: Using configuration from #{config_file}" if debug
       puts "DEBUG: Current configuration: #{@options}" if debug
+
+      validate_config
     end
 
     def base_uri
@@ -27,22 +26,28 @@ module SingularityClient
     end
 
     def debug
-      @options.key?('debug')
+      @options.key? 'debug'
     end
 
     private
 
-    def find_config_file(dir)
-      Pathname.new(File.expand_path(dir)).ascend do |path|
-        file = File.join(path.to_s, DOTFILE)
-        return file if File.exist?(file)
+    def validate_config
+      required_fields = %w(
+        singularity_url
+        singularity_port
+      )
+
+      required_fields.all? do |field|
+        if @options.key? field
+          true
+        else
+          fail <<-ERR.gsub(/^[\s\t]*/, '').gsub(/[\s\t]*\n/, ' ').strip
+            #{field} not defined. Please see
+            https://github.com/behance/singularity_client#configuration
+            for configuration options
+          ERR
+        end
       end
-
-      fail 'Could not find .singularity.yml'
-    end
-
-    def load_from_file(file)
-      YAML.load_file(file)
     end
   end
 end

data/lib/singularity_client/config_loader.rb

@@ -0,0 +1,31 @@
+# encoding: utf-8
+
+require 'yaml'
+require 'pathname'
+
+module SingularityClient
+  # Wrapper around the config object
+  class ConfigLoader
+    DOTFILE = '.singularity.yml'
+
+    def self.load_from_file(file = false, debug = false)
+      # If file is defined don't look for one, else find one
+      file = find_config_file('.', debug) unless file
+
+      # If no config file passed in, and none found, return empty hash
+      file ? YAML.load_file(file) : {}
+    end
+
+    def self.find_config_file(dir, debug)
+      Pathname.new(File.expand_path(dir)).ascend do |path|
+        file = File.join(path.to_s, DOTFILE)
+        if File.exist?(file)
+          puts "DEBUG: Using configuration from #{file}" if debug
+          return file
+        end
+      end
+
+      puts 'DEBUG: Could not find .singularity.yml' if debug
+    end
+  end
+end

data/lib/singularity_client/version.rb

@@ -2,5 +2,5 @@
 
 # Version
 module SingularityClient
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

data/lib/singularity_client.rb

@@ -3,3 +3,4 @@
 require 'singularity_client/version'
 require 'singularity_client/api'
 require 'singularity_client/config'
+require 'singularity_client/config_loader'

data/spec/singularity_client/api_spec.rb

@@ -45,15 +45,41 @@ describe SingularityClient::API do
   end
 
   describe '.add' do
-    subject(:add) do
-      SingularityClient::API.add(config_obj, 'test_repo', 'test_project')
+
+    describe 'Adding a pull_request' do
+      subject(:add) do
+        SingularityClient::API.add(config_obj,
+                                   'test_repo',
+                                   'test_project',
+                                   'pull_request'
+        )
+      end
+
+      describe 'when it receives a succesful response' do
+        it 'it returns success!' do
+          VCR.use_cassette('addPull') do
+            expect(STDOUT).to receive(:puts).with('success!')
+            add
+          end
+        end
+      end
     end
 
-    describe 'when it receives a succesful response' do
-      it 'it returns success!' do
-        VCR.use_cassette('add') do
-          expect(STDOUT).to receive(:puts).with('success!')
-          add
+    describe 'Adding a push' do
+      subject(:add) do
+        SingularityClient::API.add(config_obj,
+                                   'test_repo',
+                                   'test_project',
+                                   'push'
+        )
+      end
+
+      describe 'when it receives a succesful response' do
+        it 'it returns success!' do
+          VCR.use_cassette('addPush') do
+            expect(STDOUT).to receive(:puts).with('success!')
+            add
+          end
         end
       end
     end

data/spec/singularity_client/config_loader_spec.rb

@@ -0,0 +1,48 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe SingularityClient::ConfigLoader do
+  describe '.load_from_file' do
+    filepath = 'test/path'
+    config = { key: 'value' }
+
+    describe 'when filepath is provided' do
+      it 'loads the provided file' do
+        expect(SingularityClient::ConfigLoader)
+          .to_not receive(:find_config_file)
+
+        expect(YAML).to receive(:load_file)
+                        .with(filepath)
+                        .and_return(config)
+
+        expect(
+          SingularityClient::ConfigLoader.load_from_file(filepath, false)
+        ).to eq(config)
+      end
+    end
+
+    describe 'when filepath is not provided' do
+      describe 'and a .singularity.yml exists' do
+        it 'loads .singularity.yml' do
+          expect(SingularityClient::ConfigLoader.load_from_file).to eq(
+            'singularity_url' => 'http://mergeatron.dev-be-aws.net',
+            'singularity_port' => '3306',
+            'github_organization' => 'BehanceOps'
+          )
+        end
+      end
+
+      describe 'and no singularity.yml exists' do
+        it 'returns an empty hash' do
+          expect(File).to receive(:exist?)
+                          .at_least(:once)
+                          .with(/.*\/.singularity.yml/)
+                          .and_return(false)
+
+          expect(SingularityClient::ConfigLoader.load_from_file).to eq({})
+        end
+      end
+    end
+  end
+end

data/spec/singularity_client/config_spec.rb

@@ -4,16 +4,20 @@ require 'spec_helper'
 
 describe SingularityClient::Config do
   describe '.initialize' do
-    describe 'when no .singularity.yml found' do
-      it 'raises an exception' do
-        expect(File).to receive(:exist?)
-                        .at_least(:once)
-                        .with(/.*\/.singularity.yml/)
-                        .and_return(false)
-
-        expect { SingularityClient::Config.new({}) }
-          .to raise_error(RuntimeError, 'Could not find .singularity.yml')
-      end
+    it 'raises an exception if validation fails' do
+      expect(File).to receive(:exist?)
+                      .at_least(:once)
+                      .with(/.*\/.singularity.yml/)
+                      .and_return(false)
+
+      error = <<-ERR.gsub(/^[\s\t]*/, '').gsub(/[\s\t]*\n/, ' ').strip
+        singularity_port not defined. Please see
+        https://github.com/behance/singularity_client#configuration
+        for configuration options
+      ERR
+      expect do
+        SingularityClient::Config.new('singularity_url' => 'test.url')
+      end .to raise_error(RuntimeError, error)
     end
   end
 

data/spec/spec_helper.rb

@@ -4,6 +4,7 @@ if ENV['COVERAGE']
   require 'simplecov'
   SimpleCov.start do
     add_filter '/spec/'
+    add_filter '/.vendor/'
   end
 end
 

data/spec/vcr_cassettes/{add.yml → addPull.yml}

@@ -19,12 +19,12 @@ http_interactions:
       Content-Length:
       - '16'
       Date:
-      - Mon, 02 Jun 2014 20:58:24 GMT
+      - Wed, 18 Jun 2014 22:58:24 GMT
       Connection:
       - keep-alive
     body:
       encoding: US-ASCII
       string: ! '{"success":true}'
-    http_version: 
-  recorded_at: Mon, 02 Jun 2014 20:58:24 GMT
+    http_version:
+  recorded_at: Wed, 18 Jun 2014 22:58:23 GMT
 recorded_with: VCR 2.9.2

data/spec/vcr_cassettes/addPush.yml

@@ -0,0 +1,30 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: http://mergeatron.dev-be-aws.net:3306/config/push
+    body:
+      encoding: US-ASCII
+      string: organization=some_org&repo=test_repo&project=test_project
+    headers: {}
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      X-Powered-By:
+      - Express
+      Content-Type:
+      - application/json
+      Content-Length:
+      - '16'
+      Date:
+      - Wed, 18 Jun 2014 22:58:24 GMT
+      Connection:
+      - keep-alive
+    body:
+      encoding: US-ASCII
+      string: ! '{"success":true}'
+    http_version:
+  recorded_at: Wed, 18 Jun 2014 22:58:23 GMT
+recorded_with: VCR 2.9.2

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: singularity_client
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-09 00:00:00.000000000 Z
+date: 2014-06-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -175,14 +175,17 @@ files:
 - lib/singularity_client/api.rb
 - lib/singularity_client/cli.rb
 - lib/singularity_client/config.rb
+- lib/singularity_client/config_loader.rb
 - lib/singularity_client/request.rb
 - lib/singularity_client/version.rb
 - singularity_client.gemspec
 - spec/singularity_client/api_spec.rb
+- spec/singularity_client/config_loader_spec.rb
 - spec/singularity_client/config_spec.rb
 - spec/singularity_client/request_spec.rb
 - spec/spec_helper.rb
-- spec/vcr_cassettes/add.yml
+- spec/vcr_cassettes/addPull.yml
+- spec/vcr_cassettes/addPush.yml
 - spec/vcr_cassettes/comment.yml
 - spec/vcr_cassettes/config.yml
 - spec/vcr_cassettes/error-get.yml
@@ -202,7 +205,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4434369719159961746
+      hash: -3052736762778204807
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -211,7 +214,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4434369719159961746
+      hash: -3052736762778204807
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -220,10 +223,12 @@ specification_version: 3
 summary: Singularity Client
 test_files:
 - spec/singularity_client/api_spec.rb
+- spec/singularity_client/config_loader_spec.rb
 - spec/singularity_client/config_spec.rb
 - spec/singularity_client/request_spec.rb
 - spec/spec_helper.rb
-- spec/vcr_cassettes/add.yml
+- spec/vcr_cassettes/addPull.yml
+- spec/vcr_cassettes/addPush.yml
 - spec/vcr_cassettes/comment.yml
 - spec/vcr_cassettes/config.yml
 - spec/vcr_cassettes/error-get.yml