bump-cli 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 45535ed74c676934e7c59f1c93ea05f7d278ee1079cc3dc7764ddda9f5f6e9bd
+  data.tar.gz: 2568282f956a77d36498075e98be4017fdf990b3c3c50bc8636a99727ca7f17d
+SHA512:
+  metadata.gz: b4d03f0d849414f60796bf4bbe48bfc2a0658b83a461cc5438c7410322866e43801b95300e1aa59f1f8c08b2649b908c7452cbd7a1c06ba23a7335279f9cf2e8
+  data.tar.gz: 6f8c00a0de00234df798f87482706d0f4d1941f6179f7ef70591a604f5ec00067cb3962b4e61336cdcf78c90d0cb6af918075dc2ec2d5e8dfa9c6099cf8a3aea

data/.circleci/config.yml

@@ -0,0 +1,43 @@
+version: 2
+jobs:
+  build-latest: &common-build
+    working_directory: ~/bump-cli
+    docker:
+      - image: circleci/ruby:latest
+    steps:
+      - checkout
+      - run:
+          name: Update bundle command
+          command: gem install bundle
+
+      - type: cache-restore
+        name: Restore bundle cache
+        keys:
+          - bump-bundle-{{ checksum "bump-cli.gemspec" }}
+          # fallback to using the latest cache if no exact match is found
+          - bump-bundle-
+
+      - run:
+          name: Bundle Install
+          command: bundle install --path vendor/bundle
+
+      - type: cache-save
+        name: Store bundle cache
+        key: bump-bundle-{{ checksum "bump-cli.gemspec" }}
+        paths:
+          - vendor/bundle
+
+      - run:
+          name: Run tests
+          command: rake
+  build-2-3:
+    <<: *common-build
+    docker:
+      - image: circleci/ruby:2.3.4-node
+
+workflows:
+  version: 2
+  build:
+    jobs:
+      - build-latest
+      - build-2-3

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.2
+before_install: gem install bundler -v 1.15.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at mehdi@lahmam.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in bump-cli.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Mehdi Lahmam
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,41 @@
+# Bump::CLI
+
+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/bump/cli`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'bump-cli'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install bump-cli
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/bump-sh/bump-cli. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Bump::CLI project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/bump-sh/bump-cli/blob/master/CODE_OF_CONDUCT.md).

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 "bump/cli"
+
+# 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(__FILE__)

data/bin/setup

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

data/bump-cli.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "bump/cli/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "bump-cli"
+  spec.version       = Bump::CLI::VERSION
+  spec.authors       = ["Mehdi Lahmam", "Sébastien Charrier"]
+  spec.email         = ["mehdi@lahmam.com", "sebastien@bump.sh"]
+
+  spec.summary       = %q{Bump.sh CLI}
+  spec.description   = %q{Bump.sh CLI to interact with the API}
+  spec.homepage      = "https://bump.sh"
+  spec.license       = "MIT"
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  spec.metadata["source_code_uri"]   = "https://github.com/bump-sh/bump-cli"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "hanami-cli", '~> 0'
+  spec.add_dependency "http", '~> 3'
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "climate_control", '~> 0'
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3"
+  spec.add_development_dependency "webmock", "~> 3"
+end

data/exe/bump

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "bump/cli"
+
+Bump::CLI.new.call

data/lib/bump/cli/commands/base.rb

@@ -0,0 +1,52 @@
+require 'open-uri'
+
+module Bump
+  class CLI
+    module Commands
+      class Base < Hanami::CLI::Command
+        private
+
+        def with_errors_rescued
+          yield
+        rescue HTTP::Error, Errno::ENOENT, SocketError => error
+          abort "Error: #{error.message}"
+        end
+
+        def headers(token: '')
+          if token
+            {
+              "Content-Type" => "application/json",
+              "Authorization" => "Basic #{Base64.strict_encode64(token + ':')}"
+            }
+          else
+            {
+              "Content-Type" => "application/json"
+            }
+          end
+        end
+
+        def display_error(response)
+          if response.code == 422
+            body = JSON.parse(response.body)
+            display_invalid_definition(body)
+          elsif response.code == 401
+            abort "Invalid credentials (status: 401)"
+          else
+            body = JSON.parse(response.body)
+            abort "Error : #{body["message"]} (status: #{response.code})"
+          end
+        rescue JSON::ParserError => e
+          abort "Unknown error (status: #{response.code})"
+        end
+
+        def display_invalid_definition(body)
+          puts "Definition is not valid:"
+          body["errors"]["raw_definition"].each do |error|
+            puts "> #{error}"
+          end
+          abort
+        end
+      end
+    end
+  end
+end

data/lib/bump/cli/commands/deploy.rb

@@ -0,0 +1,40 @@
+require 'base64'
+
+module Bump
+  class CLI
+    module Commands
+      class Deploy < Base
+        desc "Create a new version"
+        argument :file, required: true, desc: "Path or URL to your API documentation file. Only OpenApi 2.0 (Swagger) specification is currently supported."
+        option :id, default: ENV.fetch("BUMP_ID", ""), desc: "Documentation public id"
+        option :token, default: ENV.fetch("BUMP_TOKEN", ""), desc: "Documentation private token"
+        option :format, default: "yaml", values: %w[yaml json], desc: "Format of the definition"
+
+        def call(file:, format:, id:, token:)
+          with_errors_rescued do
+            response = HTTP
+              .headers(headers(token: token))
+              .post(API_URL + "/docs/#{id}/versions", body: body(file, format).to_json)
+
+            if response.code == 201
+              puts "New version has been successfully deployed."
+            elsif response.code == 204
+              puts "Version was already deployed."
+            else
+              display_error(response)
+            end
+          end
+        end
+
+        private
+
+        def body(file, format)
+          {
+            definition: open(file).read,
+            format: format
+          }
+        end
+      end
+    end
+  end
+end

data/lib/bump/cli/commands/preview.rb

@@ -0,0 +1,35 @@
+module Bump
+  class CLI
+    module Commands
+      class Preview < Base
+        desc "Create a documentation preview for the given file"
+        argument :file, required: true, desc: "Path or URL to your API documentation file. Only OpenApi 2.0 (Swagger) specification is currently supported."
+        option :format, default: "yaml", values: %w[yaml json], desc: "Format of the definition"
+
+        def call(**options)
+          with_errors_rescued do
+            response = HTTP
+              .headers(headers)
+              .post(API_URL + "/previews", body: body(options).to_json)
+
+            if response.code == 201
+              body = JSON.parse(response.body)
+              puts "Preview created : #{ROOT_URL + '/preview/' + body['id']} (expires at #{body['expires_at']})"
+            else
+              display_error(response)
+            end
+          end
+        end
+
+        private
+
+        def body(options)
+          {
+            definition: open(options.fetch(:file)).read,
+            format: options.fetch(:format)
+          }
+        end
+      end
+    end
+  end
+end

data/lib/bump/cli/commands/validate.rb

@@ -0,0 +1,38 @@
+require 'base64'
+
+module Bump
+  class CLI
+    module Commands
+      class Validate < Base
+        desc "Validate a given file against its schema definition"
+        argument :file, required: true, desc: "Path or URL to your API documentation file. Only OpenApi 2.0 (Swagger) specification is currently supported."
+        option :id, default: ENV.fetch("BUMP_ID", ""), desc: "Documentation public id"
+        option :token, default: ENV.fetch("BUMP_TOKEN", ""), desc: "Documentation private token"
+        option :format, default: "yaml", values: %w[yaml json], desc: "Format of the definition"
+
+        def call(file:, format:, id:, token:)
+          with_errors_rescued do
+            response = HTTP
+              .headers(headers(token: token))
+              .post(API_URL + "/docs/#{id}/validations", body: body(file, format).to_json)
+
+            if response.code == 200
+              puts "Definition is valid."
+            else
+              display_error(response)
+            end
+          end
+        end
+
+        private
+
+        def body(file, format)
+          {
+            definition: open(file).read,
+            format: format
+          }
+        end
+      end
+    end
+  end
+end

data/lib/bump/cli/version.rb

@@ -0,0 +1,5 @@
+module Bump
+  class CLI
+    VERSION = "0.1.0"
+  end
+end

data/lib/bump/cli.rb

@@ -0,0 +1,28 @@
+require "bump/cli/version"
+require "hanami/cli"
+require "http"
+
+module Bump
+  class CLI
+    ROOT_URL = "https://bump.sh".freeze
+    API_PATH = "/api/v1".freeze
+    API_URL = ROOT_URL + API_PATH
+
+    def call(*args)
+      Hanami::CLI.new(Commands).call(*args)
+    end
+
+    module Commands
+      extend Hanami::CLI::Registry
+    end
+  end
+end
+
+require "bump/cli/commands/base"
+require "bump/cli/commands/deploy"
+require "bump/cli/commands/preview"
+require "bump/cli/commands/validate"
+
+Bump::CLI::Commands.register "deploy", Bump::CLI::Commands::Deploy
+Bump::CLI::Commands.register "preview", Bump::CLI::Commands::Preview
+Bump::CLI::Commands.register "validate", Bump::CLI::Commands::Validate

metadata

@@ -0,0 +1,165 @@
+--- !ruby/object:Gem::Specification
+name: bump-cli
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mehdi Lahmam
+- Sébastien Charrier
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-03-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: hanami-cli
+  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: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: climate_control
+  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: 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: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+description: Bump.sh CLI to interact with the API
+email:
+- mehdi@lahmam.com
+- sebastien@bump.sh
+executables:
+- bump
+extensions: []
+extra_rdoc_files: []
+files:
+- ".circleci/config.yml"
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- bump-cli.gemspec
+- exe/bump
+- lib/bump/cli.rb
+- lib/bump/cli/commands/base.rb
+- lib/bump/cli/commands/deploy.rb
+- lib/bump/cli/commands/preview.rb
+- lib/bump/cli/commands/validate.rb
+- lib/bump/cli/version.rb
+homepage: https://bump.sh
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  source_code_uri: https://github.com/bump-sh/bump-cli
+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.7.4
+signing_key: 
+specification_version: 4
+summary: Bump.sh CLI
+test_files: []