snap_ci_manual_trigger 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c5aa2cc6e0dd62b83a69a55d927fb364e505a361
-  data.tar.gz: 3400261f1f6f75c8dd6bd2d518d19bcd0a64967c
+  metadata.gz: 58e71b58cac95103a8c1524e356e1c81d3299b38
+  data.tar.gz: 7eab4a9320362c1ee161fcc2a0f321322ddceeda
 SHA512:
-  metadata.gz: 5776d5deb58c6144d6467806daa2067a2b58f485af11e07f1aa70703778aa7479f3ab034705b9a6ac19b54bee9ae738fe14e373df19d7d7322ba44fc4dc5f6c5
-  data.tar.gz: d3632c1ba6173bbee18a5ba5eaa18c33dc6bc8967e9373ced989005a6131d4f0bf5b95dd87669c85c1a307510e2df28ed9d8a6d2e94be99bceb09f4b0e1ce772
+  metadata.gz: 8bc18f5af8fc50311c3a73c562292643547f71eba1d4c37038cb97822cbf41ac332ff49673b82085423a7ed77805e34066de568218274e85d0389c7bfb5b33bc
+  data.tar.gz: 11395bf39a3ce48d9c99498f0e0a090c695a7c9567e19b67851afd7ad45254c4247d5b981434a1afb86b714a4d758096a41fe9706222dda31d3f92feb0fb3d34

data/.gitignore

@@ -7,3 +7,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+/spec/lib/tmp/*

data/.travis.yml

@@ -3,6 +3,10 @@ rvm:
   - 2.1.2
 before_install: gem install bundler -v 1.10.5
 
+addons:
+  code_climate:
+    repo_token: 3fc20ac63456f30ae0b08dcf864b1b775a70f12380a0ee281d33a654e35f0a70
+
 script: 'bundle exec rake spec'
 
 notifications:

data/README.md

@@ -52,7 +52,28 @@ 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. 
+This gem adds a generator to create specific rake tasks that will make things easier.
+ 
+We invoke the generator like this:
+
+```shell
+rails generate snap_ci_manual_trigger:rake_tasks my-org my-repo
+```
+
+And it will create a rake task for calling `manual_stage_on_new_pipeline` there. It will be used like this:
+
+```shell
+# this will call for the 'Deploy' stage in a new pipeline in my-org/my-repo in branch 'master'
+rake snap_ci:my-org_my-repo[Deploy]
+
+# this will call for the 'Deploy' stage in a new pipeline in my-org/my-repo in branch 'other_branch'
+rake snap_ci:my-org_my-repo[Deploy,other_branch]
+```
+
+It reads the credentials from ENV (required):
+ 
+- `SNAP_CI_USER`: Snap-CI username
+- `SNAP_CI_API_KEY`: Snap-CI API Key
 
 ## Development
 
@@ -64,3 +85,10 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/artirix/snap_ci_manual_trigger.
 
+
+## CHANGES
+
+### v.1.0.0
+
+- Generators added
+- major version bump since we now require railties, which could be a breaking change

data/lib/generators/snap_ci_manual_trigger/rake_tasks_generator.rb

@@ -0,0 +1,24 @@
+require 'rails/generators/base'
+
+module SnapCiManualTrigger
+  module Generators
+    class RakeTasksGenerator < Rails::Generators::Base
+      source_root File.expand_path('../templates', __FILE__)
+
+      desc <<-DESC.strip_heredoc
+        Creates rake tasks for the given owner/repository pair (will generate file in "lib/tasks/snap_ci/OWNER_REPOSITORY.rake")
+
+        For example:
+          rails generate snap_ci_manual_trigger:rake_tasks my-org my-repo
+
+      DESC
+
+      argument :owner, required: true, desc: 'The owner in Snap-CI'
+      argument :repository, required: true, desc: 'The repository in Snap-CI'
+
+      def create_tasks
+        template 'rake_tasks.rb.erb', "lib/tasks/snap_ci/#{owner}_#{repository}.rake"
+      end
+    end
+  end
+end

data/lib/generators/snap_ci_manual_trigger/templates/rake_tasks.rb.erb

@@ -0,0 +1,55 @@
+namespace :snap_ci do
+  desc <<-DESC.strip_heredoc
+    executes #manual_stage_on_new_pipeline using <%= owner.inspect %> as owner and <%= repository.inspect %> as repository
+
+    example:
+      rake <%= owner %>_<%= repository %>:manual_stage_on_new_pipeline[Deploy]
+
+    if you want a different branch (master by default) then add a second argument
+
+    example:
+      rake <%= owner %>_<%= repository %>:manual_stage_on_new_pipeline[Deploy,my_branch]
+
+  DESC
+
+  task :'<%= owner %>_<%= repository %>', [:stage, :branch_name] => [:environment] do |t, args|
+    args.with_defaults branch_name: 'master'
+
+    owner       = '<%= owner %>'
+    repository  = '<%= repository %>'
+    stage       = args[:stage]
+    branch_name = args[:branch_name]
+    user        = ENV['SNAP_CI_USER']
+    api_key     = ENV['SNAP_CI_API_KEY']
+
+    if stage.blank?
+    raise SnapCiManualTrigger::MissingRakeArgumentsError,
+          'missing stage!'
+    end
+
+    if branch_name.blank?
+    raise SnapCiManualTrigger::MissingRakeArgumentsError,
+          'missing branch_name!'
+    end
+
+    if user.blank?
+      raise SnapCiManualTrigger::MissingRakeAuthError,
+            'missing snap CI User! use ENV variable SNAP_CI_USER'
+    end
+
+    if api_key.blank?
+      raise SnapCiManualTrigger::MissingRakeAuthError,
+            'missing snap CI API Key! use ENV variable SNAP_CI_API_KEY'
+    end
+
+    service = SnapCiManualTrigger.for user: user,
+                                      api_key: api_key,
+                                      owner: owner,
+                                      repository: repository,
+                                      branch_name: branch_name
+
+    url = service.manual_stage_on_new_pipeline stage
+
+    puts "Stage #{stage} called. URL in SnapCI: #{url}"
+  end
+end

data/lib/snap_ci_manual_trigger/missing_rake_arguments_error.rb

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

data/lib/snap_ci_manual_trigger/missing_rake_auth_error.rb

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

data/lib/snap_ci_manual_trigger/version.rb

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

data/lib/snap_ci_manual_trigger.rb

@@ -8,6 +8,17 @@ require 'snap_ci_manual_trigger/invalid_credentials_error'
 require 'snap_ci_manual_trigger/invalid_resource_error'
 require 'snap_ci_manual_trigger/service'
 
+
+# GENERATORS
+
+require 'thor'
+require 'rails/generators'
+require 'rails/generators/actions'
+
+require 'generators/snap_ci_manual_trigger/rake_tasks_generator'
+require 'snap_ci_manual_trigger/missing_rake_arguments_error'
+require 'snap_ci_manual_trigger/missing_rake_auth_error'
+
 module SnapCiManualTrigger
   DEFAULT_BRANCH_NAME = 'master'.freeze
 

data/snap_ci_manual_trigger.gemspec

@@ -21,8 +21,12 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'faraday'
   spec.add_dependency 'oj'
   spec.add_dependency 'oj_mimic_json'
+
+  spec.add_dependency 'railties', '>= 3.2', '< 5' # for the generators
+
   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'
+  spec.add_development_dependency 'generator_spec'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: snap_ci_manual_trigger
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Eduardo Turiño
@@ -66,6 +66,26 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -122,6 +142,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: generator_spec
+  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
@@ -137,9 +171,13 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- lib/generators/snap_ci_manual_trigger/rake_tasks_generator.rb
+- lib/generators/snap_ci_manual_trigger/templates/rake_tasks.rb.erb
 - 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/missing_rake_arguments_error.rb
+- lib/snap_ci_manual_trigger/missing_rake_auth_error.rb
 - lib/snap_ci_manual_trigger/service.rb
 - lib/snap_ci_manual_trigger/version.rb
 - snap_ci_manual_trigger.gemspec