semaph 0.2.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b22217dbedbfa234279e494e23d64af812563e6fa8d57e2e2b14f185b3fbe52c
-  data.tar.gz: 36c3a0944ef6408730c18b2f147f734616300023792e9e82b0c5ebc0956bab05
+  metadata.gz: 7db37cbca829e1b13372c7a8687b86080b1e4a579bbb7707e6cc207ebdcb4ba1
+  data.tar.gz: 4b5015379f62ad0382991f26b525583d2a6e077889071e5bde58dc1399d69ada
 SHA512:
-  metadata.gz: 4fdda4999337920b39947b2c2fe09ea2cf62830998f948fed2d835dd74f5436172276dace4d59f0e493f14381aae349aaa0aafaa123b5f452ab4ed6a1fba0db0
-  data.tar.gz: c5f969a3450d98f8a9b7a9eeb66d134856558e0376259070206ad0a8e76d4e3c38e6a12e3b27312aa272a48cc08af50288e99b443983ffc1d374d5401f82eb85
+  metadata.gz: 243de9cc3425299a5d7a5a11d3a6e06a89e56ad22e0bab59fe4568544fc8e05f0a6e902363497d493811a00c30f84a95456a0679417fb7d4d39b10ad35ece692
+  data.tar.gz: f1fd8d22e22885357f0b5c1ba962ac1edb91b61b6ab3b9e03cfec9aeda88197a40bfcfe2b047417d3d2629e5eb8f9fa3e32b9dde40e8feefeb09bae8e7e5527d

data/.gitignore

@@ -1,4 +1,5 @@
 .DS_Store
+*.log
 
 /.bundle/
 /.yardoc
@@ -7,4 +8,4 @@
 /doc/
 /pkg/
 /spec/reports/
-/tmp/
+/tmp/

data/.rubocop.yml

@@ -1,3 +1,42 @@
+Layout/EmptyLinesAroundAttributeAccessor:
+  Enabled: true
+
+Layout/SpaceAroundMethodCallOperator:
+  Enabled: true
+
+Lint/DeprecatedOpenSSLConstant:
+  Enabled: true
+
+Lint/MixedRegexpCaptureTypes:
+  Enabled: true
+
+Lint/RaiseException:
+  Enabled: true
+
+Lint/StructNewOverride:
+  Enabled: true
+
+Style/ExponentialNotation:
+  Enabled: true
+
+Style/HashEachMethods:
+  Enabled: true
+
+Style/HashTransformKeys:
+  Enabled: true
+
+Style/HashTransformValues:
+  Enabled: true
+
+Style/RedundantRegexpCharacterClass:
+  Enabled: true
+
+Style/RedundantRegexpEscape:
+  Enabled: true
+
+Style/SlicingWithRange:
+  Enabled: true
+
 Style/Documentation:
   Enabled: false
 

data/.semaphore/semaphore.yml

@@ -16,4 +16,8 @@ blocks:
       - name: Build
         commands:
           - checkout
-          - echo "done"
+          - sem-version ruby $(grep ruby .tool-versions | cut -d ' ' -f 2)
+          - cache restore $(git ls-tree HEAD Gemfile.lock | cut -f3 -d$' ' | cut -f1 -d$'\t')
+          - bundle install --deployment --path vendor/bundle
+          - cache store $(git ls-tree HEAD Gemfile.lock | cut -f3 -d$' ' | cut -f1 -d$'\t') vendor/bundle
+          - bundle exec rake

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    semaph (0.1.0)
+    semaph (0.7.0)
       faraday
       rainbow
       shell_shock
@@ -9,18 +9,37 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
+    ast (2.4.0)
     coderay (1.1.2)
     faraday (1.0.1)
       multipart-post (>= 1.2, < 3)
     method_source (1.0.0)
     minitest (5.14.1)
     multipart-post (2.1.1)
+    parallel (1.19.1)
+    parser (2.7.1.3)
+      ast (~> 2.4.0)
     pry (0.13.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
     rainbow (3.0.0)
     rake (12.3.3)
+    regexp_parser (1.7.0)
+    rexml (3.2.4)
+    rubocop (0.85.0)
+      parallel (~> 1.10)
+      parser (>= 2.7.0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.7)
+      rexml
+      rubocop-ast (>= 0.0.3)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (0.0.3)
+      parser (>= 2.7.0.1)
+    ruby-progressbar (1.10.1)
     shell_shock (0.0.5)
+    unicode-display_width (1.7.0)
 
 PLATFORMS
   ruby
@@ -29,6 +48,7 @@ DEPENDENCIES
   minitest (~> 5.0)
   pry
   rake (~> 12.0)
+  rubocop
   semaph!
 
 BUNDLED WITH

data/README.md

@@ -1,28 +1,102 @@
 # Semaph
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/semaph`. To experiment with that code, run `bin/console` for an interactive prompt.
+This is command line shell for interacting with [semaphoreci 2.0](http://docs.semaphoreci.com/).
+
+It complements the [sem](https://docs.semaphoreci.com/reference/sem-command-line-tool/) tool with some
+overlap in responsibilities.
 
-TODO: Delete this and the text above, and describe your gem
 
 ## Installation
 
-Add this line to your application's Gemfile:
+    gem install semaph
+
+## Usage
+
+To set up authentication to semaphoreci, you can just follow the instructions to install and setup
+[sem](https://docs.semaphoreci.com/reference/sem-command-line-tool/).  This will result
+in your authentication details being written to `~/.sem.yaml`.
 
-```ruby
-gem 'semaph'
+You should see something like the following in this file:
+
+```yaml
+active-context: foo_semaphoreci_com
+contexts:
+  foo_semaphoreci_com:
+    auth:
+      token: qwerty
+    host: foo.semaphoreci.com
 ```
 
-And then execute:
+Now you can run `semaph` and will be presented with a prompt like one of the following:
 
-    $ bundle install
+     🏗  >
 
-Or install it yourself as:
+or
 
-    $ gem install semaph
+     🏗  foo.semaphoreci.com >
 
-## Usage
+This is the first of a series of nested shells.  Each shell represents a different context
+and has different commands available.  To see the commands available, execute `help` and
+to see the details of a particular command, execute `help <command name>`.  Once you are
+familar with the commands for each context, you can type the first couple of characters
+and then hit tab to complete the rest.  For some commands you can also tab complete the
+parameters. Once you enter a shell, return to the previous shell or exit `semaph`, you can
+press ctrl-d.
+
+### organisations shell
+
+     🏗  >
+
+You will only see this shell if you have multiple sets of credentials in your `~/.sem.yml` file.
+
+From this shell, you can `list-organisations` you are authenticated to and `select-organisation`
+to enter a shell for that organisation.
+
+### organisation shell
+
+     🏗  foo.semaphoreci.com >
+
+If you have only one set of credentials in `~/.sem.yml` then this will be the initial shell.
+
+From here you can `list-projects` and then `select-project` to enter a shell for that project.
+
+### project shell
+
+     🏗  foo.semaphoreci.com my-app >
+
+From this shell, you will mostly be interested in `list-workflows <branch>` (where 'branch' is any
+substring of the git branch you want to see workflows for) and then `select-workflow <index>`
+(where 'index' is the number displayed for each workflow `list-workflows` - tab completion on uuids
+seemed a bad idea) to enter a shell for that specific workflow.
+
+You can also `open-github` (opens a web browser for the github project associated with the project) and `open-project`
+(opens the semaphoreci project in a browser).
+
+### workflow shell
+
+    🏗  foo.semaphoreci.com my-app workflowuuid >
+
+From this shell, you can `list-pipelines` for the selected workflow.  These are the builds usually starting
+from `semaphore.yml` plus any promotion pipelines that might be executed.  You can `select-pipeline` to monitor
+what's happening with the pipeline.
+
+You can also `open-github-branch`, `open-github-commit` to see the branch/commit in a browser and
+`open-workflow`, `open-branch` to see the semaphore branch/workflow in a browser.
+
+### pipeline shell
+
+    🏗  foo.semaphoreci.com my-app workflowuuid semaphore.yml >
+
+From this shell, you can `list-jobs`, `poll-jobs`, `job-log` and `grep-logs`.
+
+Job polling will stop as soon as any one job has failed and send a system notification
+(as long as `terminal-notifier` is installed).
+
+You can look at the log for a specific job (by the index presented in `list-jobs`) using `less`.
+
+You can grep across all jobs (using `ag`) with `grep-logs` which will download the logs for all completed jobs.
 
-TODO: Write usage instructions here
+You can also open the same browser views in semaphoreci and github from this shell.
 
 ## Development
 

data/Rakefile

@@ -1,5 +1,6 @@
 require "bundler/gem_tasks"
 require "rake/testtask"
+require "rubocop/rake_task"
 
 Rake::TestTask.new(:test) do |t|
   t.libs << "test"
@@ -7,4 +8,6 @@ Rake::TestTask.new(:test) do |t|
   t.test_files = FileList["test/**/*_test.rb"]
 end
 
-task default: :test
+RuboCop::RakeTask.new(:cop)
+
+task default: %i[cop test]

data/lib/semaph/client.rb

@@ -0,0 +1,115 @@
+require "faraday"
+require "json"
+
+module Semaph
+  # Refer to https://docs.semaphoreci.com/reference/api-v1alpha/
+  class Client
+    class RequestException < RuntimeError
+      attr_reader :url, :response
+
+      def initialize(url, response)
+        @url = url
+        @response = response
+        super("http response #{response.status} received for #{url}:\n#{response.body}")
+      end
+    end
+
+    attr_reader :host, :name
+
+    def initialize(token, host)
+      @token = token
+      @host = host
+      @name = host.split(".").first
+      @host_url = "https://#{host}"
+      @base = "#{@host_url}/api/v1alpha"
+    end
+
+    def projects
+      get "projects"
+    end
+
+    def workflows(project_id)
+      get "plumber-workflows", { project_id: project_id }
+    end
+
+    def workflow(workflow_id)
+      get "plumber-workflows/#{workflow_id}"
+    end
+
+    def stop_workflow(workflow_id)
+      post "plumber-workflows/#{workflow_id}/terminate"
+    end
+
+    def rerun_workflow(workflow_id)
+      post "plumber-workflows/#{workflow_id}/reschedule?request_token=#{workflow_id}"
+    end
+
+    def pipelines(options)
+      get "pipelines", options
+    end
+
+    def pipeline(id)
+      get "pipelines/#{id}", { detailed: true }
+    end
+
+    def promotions(pipeline_id)
+      get "promotions", { pipeline_id: pipeline_id }
+    end
+
+    def promote(pipeline_id, name)
+      post "promotions", { pipeline_id: pipeline_id, name: name }
+    end
+
+    def job(id)
+      get "jobs/#{id}"
+    end
+
+    def stop_job(id)
+      post "jobs/#{id}/stop"
+    end
+
+    def job_log(id)
+      get_raw "jobs/#{id}/plain_logs.json"
+    end
+
+    private
+
+    def get_raw(path, params = {})
+      url = "#{@host_url}/#{path}"
+      puts url if ENV["SEMAPH_DEBUG"]
+      response = Faraday.get(url, params, { "Authorization" => "Token #{@token}" })
+      check_response(response, url)
+    end
+
+    def get(path, params = {})
+      url = "#{@base}/#{path}"
+      puts url if ENV["SEMAPH_DEBUG"]
+      response = Faraday.get(url, params, headers)
+      JSON.parse(check_response(response, url)).tap do |hash|
+        pp hash if ENV["SEMAPH_DEBUG"]
+      end
+    end
+
+    def post(path, params = {})
+      url = "#{@base}/#{path}"
+      response = Faraday.post(url, params.to_json, headers)
+      JSON.parse(check_response(response, url)).tap do |hash|
+        pp hash if ENV["SEMAPH_DEBUG"]
+      end
+    end
+
+    def headers
+      {
+        "Authorization" => "Token #{@token}",
+        "Content-Type" => "application/json",
+        "Accept" => "application/json",
+      }
+    end
+
+    def check_response(response, url)
+      return response.body if response.status == 200
+
+      raise RequestException.new(url, response)
+    end
+  end
+end

data/lib/semaph/commands.rb

@@ -0,0 +1,63 @@
+require "semaph/commands/reload_command"
+require "semaph/commands/rerun_workflow_command"
+require "semaph/commands/stop_workflow_command"
+require "semaph/commands/visit_url_command"
+
+module Semaph
+  module Commands
+    def self.workflow_commands(shell, workflow)
+      shell.add_command ::Semaph::Commands::RerunWorkflowCommand.new(workflow), "rerun"
+      shell.add_command ::Semaph::Commands::StopWorkflowCommand.new(workflow), "stop"
+      add_open_workflow_command(shell, workflow)
+      add_open_branch_command(shell, workflow)
+      add_github_commands(shell, workflow)
+    end
+
+    def self.add_open_workflow_command(shell, workflow)
+      shell.add_command(
+        ::Semaph::Commands::VisitUrlCommand.new(
+          "https://#{workflow.project.client.host}/workflows/#{workflow.id}",
+          "browse to workflow",
+        ),
+        "open-workflow",
+      )
+    end
+
+    def self.add_open_branch_command(shell, workflow)
+      shell.add_command(
+        ::Semaph::Commands::VisitUrlCommand.new(
+          "https://#{workflow.project.client.host}/branches/#{workflow.branch_id}",
+          "browse to branch in semaphore",
+        ),
+        "open-branch",
+      )
+    end
+
+    def self.add_github_commands(shell, workflow)
+      return unless workflow.project.github_url
+
+      add_github_branch(shell, workflow)
+      add_github_commit(shell, workflow)
+    end
+
+    def self.add_github_branch(shell, workflow)
+      shell.add_command(
+        ::Semaph::Commands::VisitUrlCommand.new(
+          "#{workflow.project.github_url}/tree/#{workflow.branch}",
+          "browse to the branch in github",
+        ),
+        "open-github-branch",
+      )
+    end
+
+    def self.add_github_commit(shell, workflow)
+      shell.add_command(
+        ::Semaph::Commands::VisitUrlCommand.new(
+          "#{workflow.project.github_url}/commit/#{workflow.sha}",
+          "browse to the commit in github",
+        ),
+        "open-github-commit",
+      )
+    end
+  end
+end

data/lib/semaph/commands/reload_command.rb

@@ -3,13 +3,14 @@ module Semaph
     class ReloadCommand
       attr_reader :help
 
-      def initialize(entity, help)
-        @entity = entity
-        @help = help
+      def initialize
+        @help = "reload all code"
       end
 
       def execute(_whatever)
-        @entity.reload
+        Dir["lib/**/*.rb"].each do |path|
+          load path
+        end
       end
     end
   end