snap_ci_manual_trigger 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c5aa2cc6e0dd62b83a69a55d927fb364e505a361
+  data.tar.gz: 3400261f1f6f75c8dd6bd2d518d19bcd0a64967c
+SHA512:
+  metadata.gz: 5776d5deb58c6144d6467806daa2067a2b58f485af11e07f1aa70703778aa7479f3ab034705b9a6ac19b54bee9ae738fe14e373df19d7d7322ba44fc4dc5f6c5
+  data.tar.gz: d3632c1ba6173bbee18a5ba5eaa18c33dc6bc8967e9373ced989005a6131d4f0bf5b95dd87669c85c1a307510e2df28ed9d8a6d2e94be99bceb09f4b0e1ce772

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,13 @@
+language: ruby
+rvm:
+  - 2.1.2
+before_install: gem install bundler -v 1.10.5
+
+script: 'bundle exec rake spec'
+
+notifications:
+  email:
+    recipients:
+      - eturino@eturino.com
+    on_failure: change
+    on_success: never

data/Gemfile

@@ -0,0 +1,15 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in snap_ci_manual_trigger.gemspec
+gemspec
+
+
+group :development, :test do
+  gem 'pry'
+  gem 'pry-nav'
+  gem 'pry-stack_explorer'
+  gem 'pry-doc'
+  gem 'pry-rescue'
+end
+
+gem 'codeclimate-test-reporter', group: :test, require: nil

data/README.md

@@ -0,0 +1,66 @@
+# SnapCiManualTrigger
+
+[![Gem Version](https://badge.fury.io/rb/snap_ci_manual_trigger.svg)](http://badge.fury.io/rb/snap_ci_manual_trigger)
+[![Build Status](https://travis-ci.org/artirix/snap_ci_manual_trigger.svg?branch=master)](https://travis-ci.org/artirix/snap_ci_manual_trigger)
+[![Code Climate](https://codeclimate.com/github/artirix/snap_ci_manual_trigger.png)](https://codeclimate.com/github/artirix/snap_ci_manual_trigger)
+[![Code Climate Coverage](https://codeclimate.com/github/artirix/snap_ci_manual_trigger/coverage.png)](https://codeclimate.com/github/artirix/snap_ci_manual_trigger)
+
+`SnapCiManualTrigger` will connect to Snap-CI's API and trigger a manual stage on 
+a given pipeline or create a new pipeline.
+ 
+
+It uses Snap-CI's API, with user and APIKEY, so it acts in a users name.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'snap_ci_manual_trigger'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install snap_ci_manual_trigger
+
+## Usage
+
+The Service object can be used programmatically. 
+
+```ruby
+service = SnapCiManualTrigger.for user: snap_ci_user, 
+                                  api_key: snap_ci_api_key,
+                                  owner: owner,
+                                  repository: repository, 
+                                  branch_name: branch_name
+                                  
+# creates a new pipeline, and returns the ID
+pipeline_id = service.new_pipeline
+
+# triggers the stage "Deploy" in the new pipeline
+running_pipeline_url = service.manual_stage stage: 'Deploy', pipeline_id: pipeline_id
+ 
+ 
+# trigger the stage "Deploy" in a new pipeline in one command
+running_pipeline_url = service.manual_stage_on_new_pipeline 'Deploy'
+```
+
+### Generate tasks
+
+TODO: generate rake tasks for quick setup of project/repo/branch, using ENV variables for Auth and overrides. 
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake rspec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/artirix/snap_ci_manual_trigger.
+

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "snap_ci_manual_trigger"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/snap_ci_manual_trigger.rb

@@ -0,0 +1,26 @@
+require 'active_support/all'
+require 'faraday'
+require 'oj'
+require 'oj_mimic_json'
+
+require 'snap_ci_manual_trigger/version'
+require 'snap_ci_manual_trigger/invalid_credentials_error'
+require 'snap_ci_manual_trigger/invalid_resource_error'
+require 'snap_ci_manual_trigger/service'
+
+module SnapCiManualTrigger
+  DEFAULT_BRANCH_NAME = 'master'.freeze
+
+  def self.for(user:, api_key:, owner:, repository:, branch_name: DEFAULT_BRANCH_NAME, connection: nil)
+    raise InvalidCredentialsError, 'it needs both user and api_key' unless user.present? && api_key.present?
+    raise InvalidResourceError, 'it needs an owner' unless owner.present?
+    raise InvalidResourceError, 'it needs an repository' unless repository.present?
+
+    Service.new user: user,
+                api_key: api_key,
+                owner: owner,
+                repository: repository,
+                branch_name: branch_name,
+                connection: connection
+  end
+end

data/lib/snap_ci_manual_trigger/invalid_credentials_error.rb

@@ -0,0 +1,2 @@
+class SnapCiManualTrigger::InvalidCredentialsError < StandardError
+end

data/lib/snap_ci_manual_trigger/invalid_resource_error.rb

@@ -0,0 +1,2 @@
+class SnapCiManualTrigger::InvalidResourceError < StandardError
+end

data/lib/snap_ci_manual_trigger/service.rb

@@ -0,0 +1,97 @@
+module SnapCiManualTrigger
+  class Service
+
+    CONNECTION_URL = 'https://api.snap-ci.com'
+
+    HEADERS = {
+      'Accept'       => 'application/vnd.snap-ci.com.v1+json',
+      'Content-type' => 'application/json',
+    }
+
+    attr_reader :user, :api_key, :owner, :repository, :branch_name, :connection
+
+    def initialize(user:, api_key:, owner:, repository:, branch_name:, connection: nil)
+      @user        = user
+      @api_key     = api_key
+      @owner       = owner
+      @repository  = repository
+      @branch_name = branch_name
+      @connection  = connection || build_connection
+    end
+
+    def new_pipeline
+      response = call_new_pipeline
+      check_unauthorized(response)
+      check_not_found(response)
+
+      parsed_response = parse_response response
+      parsed_response['counter']
+    end
+
+    def manual_stage(pipeline:, stage:)
+      response = call_manual_stage pipeline, stage
+      check_unauthorized(response)
+      check_not_found(response, pipeline, stage)
+
+      parsed_response = parse_response response
+      parsed_response['_embedded']['_links']['self']['href']
+    end
+
+    def manual_stage_on_new_pipeline(stage)
+      pipeline_id = new_pipeline
+      manual_stage pipeline: pipeline_id, stage: stage
+    end
+
+    private
+
+    def check_unauthorized(response)
+      if response.status == 401
+        raise SnapCiManualTrigger::InvalidCredentialsError, 'User - API Key pair invalid, request not authorized'
+      end
+    end
+
+    def check_not_found(response, pipeline = nil, stage = nil)
+      if response.status == 404
+        resource_data            = {
+          owner:       owner,
+          repository:  repository,
+          branch_name: branch_name
+        }
+
+        resource_data[:pipeline] = pipeline if pipeline.present?
+        resource_data[:stage]    = stage if stage.present?
+
+        raise SnapCiManualTrigger::InvalidResourceError, "resource not found: #{resource_data.inspect}"
+      end
+    end
+
+    def parse_response(response)
+      Oj.load response.body
+    end
+
+    def build_connection
+      Faraday.new(url: CONNECTION_URL, request: { params_encoder: Faraday::FlatParamsEncoder }) do |faraday|
+        faraday.basic_auth(user, api_key)
+        faraday.request :url_encoded # form-encode POST params
+        # faraday.response :logger # log requests to STDOUT
+        faraday.adapter Faraday.default_adapter
+      end
+    end
+
+    def call_new_pipeline
+      connection.post new_pipeline_path, nil, HEADERS
+    end
+
+    def call_manual_stage(pipeline, stage)
+      connection.post manual_stage_path(pipeline, stage), nil, HEADERS
+    end
+
+    def new_pipeline_path
+      "/project/#{owner}/#{repository}/branch/#{branch_name}/trigger"
+    end
+
+    def manual_stage_path(pipeline, stage)
+      "/project/#{owner}/#{repository}/branch/#{branch_name}/trigger/#{pipeline}/#{stage}"
+    end
+  end
+end

data/lib/snap_ci_manual_trigger/version.rb

@@ -0,0 +1,3 @@
+module SnapCiManualTrigger
+  VERSION = '0.1.0'
+end

data/snap_ci_manual_trigger.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'snap_ci_manual_trigger/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'snap_ci_manual_trigger'
+  spec.version       = SnapCiManualTrigger::VERSION
+  spec.authors       = ['Eduardo Turiño']
+  spec.email         = ['eturino@eturino.com']
+
+  spec.summary       = %q{Helps triggering specific steps on Snap-CI using API}
+  spec.homepage      = 'https://github.com/artirix/snap_ci_manual_trigger'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'activesupport'
+  spec.add_dependency 'faraday'
+  spec.add_dependency 'oj'
+  spec.add_dependency 'oj_mimic_json'
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'stub_env'
+end

metadata

@@ -0,0 +1,170 @@
+--- !ruby/object:Gem::Specification
+name: snap_ci_manual_trigger
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Eduardo Turiño
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-08-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: oj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: oj_mimic_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: stub_env
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- eturino@eturino.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/snap_ci_manual_trigger.rb
+- lib/snap_ci_manual_trigger/invalid_credentials_error.rb
+- lib/snap_ci_manual_trigger/invalid_resource_error.rb
+- lib/snap_ci_manual_trigger/service.rb
+- lib/snap_ci_manual_trigger/version.rb
+- snap_ci_manual_trigger.gemspec
+homepage: https://github.com/artirix/snap_ci_manual_trigger
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.3
+signing_key: 
+specification_version: 4
+summary: Helps triggering specific steps on Snap-CI using API
+test_files: []
+has_rdoc: