dpl-releases 1.9.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 44e70cc91d21e963c4aeb3f8e1db0bea45fae7b8
+  data.tar.gz: 933d5352e2199ee2cc1659d830aee46e5e85f651
+SHA512:
+  metadata.gz: e967a9c342b0fab62d6ac5d1587885ec2d6c5b45fbc7204f18582c5d607076e1a52ecec595d15efc71f811189559a47b57aa5d579782980d3f69a3d856c4f0d4
+  data.tar.gz: 1fe1bb7d81f066a76baceb071b1b2f52c81c1cee051ae26304314d7df6e10405fd4da53fbaddf6e9862842a5be830f55fabd7312526993d080d72d47b74adc81

data/dpl-releases.gemspec

@@ -0,0 +1,3 @@
+require './gemspec_helper'
+
+gemspec_for 'releases', [['octokit', '~> 4.6.2'], ['mime-types', '~> 2.0']]

data/lib/dpl/provider/releases.rb

@@ -0,0 +1,134 @@
+require 'octokit'
+require 'mime-types'
+
+module DPL
+  class Provider
+    class Releases < Provider
+      require 'pathname'
+
+      def travis_tag
+        # Check if $TRAVIS_TAG is unset or set but empty
+        if context.env.fetch('TRAVIS_TAG','') == ''
+          nil
+        else
+          context.env['TRAVIS_TAG']
+        end
+      end
+
+      def get_tag
+        if travis_tag.nil?
+          @tag ||= `git describe --tags --exact-match 2>/dev/null`.chomp
+        else
+          @tag ||= travis_tag
+        end
+      end
+
+      def api
+        if options[:user] and options[:password]
+          @api ||= Octokit::Client.new(:login => options[:user], :password => options[:password])
+        else
+          @api ||= Octokit::Client.new(:access_token => option(:api_key))
+        end
+      end
+
+      def slug
+        options.fetch(:repo) { context.env['TRAVIS_REPO_SLUG'] }
+      end
+
+      def releases
+        @releases ||= api.releases(slug)
+      end
+
+      def user
+        @user ||= api.user
+      end
+
+      def files
+        if options[:file_glob]
+          Array(options[:file]).map do |glob|
+            Dir.glob(glob)
+          end.flatten
+        else
+          Array(options[:file])
+        end
+      end
+
+      def needs_key?
+        false
+      end
+
+      def check_app
+        log "Deploying to repo: #{slug}"
+
+        context.shell 'git fetch --tags' if travis_tag.nil?
+        log "Current tag is: #{get_tag}"
+      end
+
+      def setup_auth
+        user.login
+      end
+
+      def check_auth
+        setup_auth
+
+        unless api.scopes.include? 'public_repo' or api.scopes.include? 'repo'
+          raise Error, "Dpl does not have permission to upload assets. Make sure your token contains the repo or public_repo scope."
+        end
+
+        log "Logged in as #{user.name}"
+      end
+
+      def push_app
+        tag_matched = false
+        release_url = nil
+
+        if options[:release_number]
+          tag_matched = true
+          release_url = "https://api.github.com/repos/" + slug + "/releases/" + options[:release_number]
+        else
+          releases.each do |release|
+            if release.tag_name == get_tag
+              release_url = release.rels[:self].href
+              tag_matched = true
+            end
+          end
+        end
+
+        #If for some reason GitHub hasn't already created a release for the tag, create one
+        if tag_matched == false
+          release_url = api.create_release(slug, get_tag, options.merge({:draft => true})).rels[:self].href
+        end
+
+        files.each do |file|
+          existing_url = nil
+          filename = Pathname.new(file).basename.to_s
+          api.release(release_url).rels[:assets].get.data.each do |existing_file|
+            if existing_file.name == filename
+              existing_url = existing_file.url
+            end
+          end
+          if !existing_url
+            upload_file(file, filename, release_url)
+          elsif existing_url && options[:overwrite]
+            log "#{filename} already exists, overwriting."
+            api.delete_release_asset(existing_url)
+            upload_file(file, filename, release_url)
+          else
+            log "#{filename} already exists, skipping."
+          end
+        end
+
+        api.update_release(release_url, {:draft => false}.merge(options))
+      end
+
+      def upload_file(file, filename, release_url)
+        content_type = MIME::Types.type_for(file).first.to_s
+        if content_type.empty?
+          # Specify the default content type, as it is required by GitHub
+          content_type = "application/octet-stream"
+        end
+        api.upload_asset(release_url, file, {:name => filename, :content_type => content_type})
+      end
+    end
+  end
+end

data/spec/provider/releases_spec.rb

@@ -0,0 +1,303 @@
+require 'spec_helper'
+require 'dpl/provider/releases'
+require 'octokit'
+
+describe DPL::Provider::Releases do
+  subject :provider do
+    described_class.new(DummyContext.new, :api_key => '0123445789qwertyuiop0123445789qwertyuiop', :file => 'blah.txt')
+  end
+
+  describe "#travis_tag" do
+    example "When $TRAVIS_TAG is nil" do
+      provider.context.env['TRAVIS_TAG'] = nil
+
+      expect(provider.travis_tag).to eq(nil)
+    end
+
+    example "When $TRAVIS_TAG if set but empty" do
+      provider.context.env['TRAVIS_TAG'] = nil
+
+      expect(provider.travis_tag).to eq(nil)
+    end
+
+    example "When $TRAVIS_TAG if set" do
+      provider.context.env['TRAVIS_TAG'] = "foo"
+
+      expect(provider.travis_tag).to eq("foo")
+    end
+  end
+
+  describe "#api" do
+    example "With API key" do
+      api = double(:api)
+      expect(::Octokit::Client).to receive(:new).with(:access_token => '0123445789qwertyuiop0123445789qwertyuiop').and_return(api)
+      expect(provider.api).to eq(api)
+    end
+
+    example "With username and password" do
+      api = double(:api)
+      provider.options.update(:user => 'foo')
+      provider.options.update(:password => 'bar')
+
+      expect(::Octokit::Client).to receive(:new).with(:login => 'foo', :password  => 'bar').and_return(api)
+      expect(provider.api).to eq(api)
+    end
+  end
+
+  describe "#releases" do
+    example "With ENV Slug" do
+      allow(provider).to receive(:slug).and_return("foo/bar")
+
+      expect(provider.api).to receive(:releases).with("foo/bar")
+      provider.releases
+    end
+
+    example "With repo option" do
+      provider.options.update(:repo => 'bar/foo')
+
+      expect(provider.api).to receive(:releases).with('bar/foo')
+      provider.releases
+    end
+  end
+
+  describe "#files" do
+    example "without file globbing and a single file" do
+      expect(provider.files).to eq(['blah.txt'])
+    end
+
+    example "without file globbing and multiple files" do
+      provider.options.update(:file => ['foo.txt', 'bar.txt'])
+      expect(provider.files).to eq(['foo.txt', 'bar.txt'])
+    end
+
+    example "with file globbing and a single glob" do
+      provider.options.update(:file_glob => true)
+      provider.options.update(:file => 'bl*.txt')
+      expect(::Dir).to receive(:glob).with('bl*.txt').and_return(['blah.txt'])
+      expect(provider.files).to eq(['blah.txt'])
+    end
+
+    example "with file globbing and multiple globs" do
+      provider.options.update(:file_glob => true)
+      provider.options.update(:file => ['f*.txt', 'b*.txt'])
+      expect(::Dir).to receive(:glob).with('f*.txt').and_return(['foo.txt'])
+      expect(::Dir).to receive(:glob).with('b*.txt').and_return(['bar.txt'])
+      expect(provider.files).to eq(['foo.txt', 'bar.txt'])
+    end
+  end
+
+  describe "#needs_key?" do
+    example do
+      expect(provider.needs_key?).to eq(false)
+    end
+  end
+
+  describe "#check_app" do
+    example "Without $TRAVIS_TAG" do
+      allow(provider).to receive(:travis_tag).and_return(nil)
+      allow(provider).to receive(:slug).and_return("foo/bar")
+      allow(provider).to receive(:get_tag).and_return("foo")
+
+      expect(provider.context).to receive(:shell).with("git fetch --tags")
+      expect(provider).to receive(:log).with("Deploying to repo: foo/bar")
+      expect(provider).to receive(:log).with("Current tag is: foo")
+
+      provider.check_app
+    end
+
+    example "With $TRAVIS_TAG" do
+      allow(provider).to receive(:travis_tag).and_return("bar")
+      allow(provider).to receive(:slug).and_return("foo/bar")
+
+      expect(provider.context).not_to receive(:shell).with("git fetch --tags")
+      expect(provider).to receive(:log).with("Deploying to repo: foo/bar")
+      expect(provider).to receive(:log).with("Current tag is: bar")
+
+      provider.check_app
+    end
+  end
+
+  describe "#get_tag" do
+    example "Without $TRAVIS_TAG" do
+      allow(provider).to receive(:travis_tag).and_return(nil)
+      allow(provider).to receive(:`).and_return("bar")
+
+      expect(provider.get_tag).to eq("bar")
+    end
+
+    example "With $TRAVIS_TAG" do
+      allow(provider).to receive(:travis_tag).and_return("foo")
+
+      expect(provider.get_tag).to eq("foo")
+    end
+  end
+
+  describe "#check_auth" do
+    example "With proper permissions" do
+      allow_message_expectations_on_nil
+      allow(provider).to receive(:user)
+      allow(provider).to receive(:setup_auth)
+      expect(provider.api).to receive(:scopes).and_return(["public_repo"])
+      expect(provider.user).to receive(:name).and_return("foo")
+      expect(provider).to receive(:log).with("Logged in as foo")
+      provider.check_auth
+    end
+
+    example "With improper permissions" do
+      allow_message_expectations_on_nil
+      allow(provider).to receive(:user)
+      allow(provider).to receive(:setup_auth)
+      expect(provider.api).to receive(:scopes).exactly(2).times.and_return([])
+      expect { provider.check_auth }.to raise_error(DPL::Error)
+    end
+  end
+
+  describe "#push_app" do
+    example "When Release Exists but has no Files" do
+      allow_message_expectations_on_nil
+
+      provider.options.update(:file => ["test/foo.bar", "bar.txt"])
+
+      allow(provider).to receive(:releases).and_return([""])
+      allow(provider).to receive(:get_tag).and_return("v0.0.0")
+
+      provider.releases.map do |release|
+        allow(release).to receive(:tag_name).and_return("v0.0.0")
+        allow(release).to receive(:rels).and_return({:self => nil})
+        allow(release.rels[:self]).to receive(:href)
+      end
+
+      allow(provider.api).to receive(:release)
+      allow(provider.api.release).to receive(:rels).and_return({:assets => nil})
+      allow(provider.api.release.rels[:assets]).to receive(:get).and_return({:data => [""]})
+      allow(provider.api.release.rels[:assets].get).to receive(:data).and_return([])
+
+      expect(provider.api).to receive(:upload_asset).with(anything, "test/foo.bar", {:name=>"foo.bar", :content_type=>"application/octet-stream"})
+      expect(provider.api).to receive(:upload_asset).with(anything, "bar.txt", {:name=>"bar.txt", :content_type=>"text/plain"})
+      expect(provider.api).to receive(:update_release).with(anything, hash_including(:draft => false))
+
+      provider.push_app
+    end
+
+    example "When Release Exists and has Files" do
+      allow_message_expectations_on_nil
+
+      provider.options.update(:file => ["test/foo.bar", "bar.txt"])
+
+      allow(provider).to receive(:releases).and_return([""])
+      allow(provider).to receive(:get_tag).and_return("v0.0.0")
+
+      provider.releases.map do |release|
+        allow(release).to receive(:tag_name).and_return("v0.0.0")
+        allow(release).to receive(:rels).and_return({:self => nil})
+        allow(release.rels[:self]).to receive(:href)
+      end
+
+      allow(provider.api).to receive(:release)
+      allow(provider.api.release).to receive(:rels).and_return({:assets => nil})
+      allow(provider.api.release.rels[:assets]).to receive(:get).and_return({:data => [""]})
+      allow(provider.api.release.rels[:assets].get).to receive(:data).and_return([double(:name => "foo.bar", :url => 'foo-bar-url'), double(:name => "foo.foo", :url => 'foo-foo-url')])
+
+      expect(provider.api).to receive(:upload_asset).with(anything, "bar.txt", {:name=>"bar.txt", :content_type=>"text/plain"})
+      expect(provider).to receive(:log).with("foo.bar already exists, skipping.")
+      expect(provider.api).to receive(:update_release).with(anything, hash_including(:draft => false))
+
+      provider.push_app
+    end
+
+    example "When Release Exists and has Files but overwrite flag is true" do
+      allow_message_expectations_on_nil
+
+      provider.options.update(:file => ["exists.txt"])
+      provider.options.update(:overwrite => true)
+
+      allow(provider).to receive(:releases).and_return([""])
+      allow(provider).to receive(:get_tag).and_return("v0.0.0")
+
+      provider.releases.map do |release|
+        allow(release).to receive(:tag_name).and_return("v0.0.0")
+        allow(release).to receive(:rels).and_return({:self => nil})
+        allow(release.rels[:self]).to receive(:href)
+      end
+
+      allow(provider.api).to receive(:release)
+      allow(provider.api.release).to receive(:rels).and_return({:assets => nil})
+      allow(provider.api.release.rels[:assets]).to receive(:get).and_return({:data => [""]})
+      allow(provider.api.release.rels[:assets].get).to receive(:data).and_return([double(:name => "exists.txt", :url => "release-url")])
+
+      expect(provider.api).to receive(:delete_release_asset).with("release-url").and_return(true)
+      expect(provider.api).to receive(:upload_asset).with(anything, "exists.txt", {:name=>"exists.txt", :content_type=>"text/plain"})
+      expect(provider.api).to receive(:update_release).with(anything, hash_including(:draft => false))
+
+      provider.push_app
+    end
+
+    example "When Release Doesn't Exist" do
+      allow_message_expectations_on_nil
+
+      provider.options.update(:file => ["test/foo.bar", "bar.txt"])
+
+      allow(provider).to receive(:releases).and_return([""])
+
+      provider.releases.map do |release|
+        allow(release).to receive(:tag_name).and_return("foo")
+        allow(release).to receive(:rels).and_return({:self => nil})
+        allow(release.rels[:self]).to receive(:href)
+      end
+
+      allow(provider.api).to receive(:create_release)
+      allow(provider.api.create_release).to receive(:rels).and_return({:self => nil})
+      allow(provider.api.create_release.rels[:slef]).to receive(:href)
+
+      allow(provider.api).to receive(:release)
+      allow(provider.api.release).to receive(:rels).and_return({:assets => nil})
+      allow(provider.api.release.rels[:assets]).to receive(:get).and_return({:data => nil})
+      allow(provider.api.release.rels[:assets].get).to receive(:data).and_return([])
+
+      expect(provider.api).to receive(:upload_asset).with(anything, "test/foo.bar", {:name=>"foo.bar", :content_type=>"application/octet-stream"})
+      expect(provider.api).to receive(:upload_asset).with(anything, "bar.txt", {:name=>"bar.txt", :content_type=>"text/plain"})
+      expect(provider.api).to receive(:update_release).with(anything, hash_including(:draft => false))
+
+      provider.push_app
+    end
+
+    example "With Release Number" do
+      allow_message_expectations_on_nil
+
+      provider.options.update(:file => ["bar.txt"])
+      provider.options.update(:release_number => "1234")
+
+      allow(provider).to receive(:slug).and_return("foo/bar")
+
+      allow(provider.api).to receive(:release)
+      allow(provider.api.release).to receive(:rels).and_return({:assets => nil})
+      allow(provider.api.release.rels[:assets]).to receive(:get).and_return({:data => nil})
+      allow(provider.api.release.rels[:assets].get).to receive(:data).and_return([])
+
+      expect(provider.api).to receive(:upload_asset).with("https://api.github.com/repos/foo/bar/releases/1234", "bar.txt", {:name=>"bar.txt", :content_type=>"text/plain"})
+      expect(provider.api).to receive(:update_release).with(anything, hash_including(:draft => false))
+
+      provider.push_app
+    end
+
+    example "When draft is true" do
+      allow_message_expectations_on_nil
+
+      provider.options.update(:file => ["bar.txt"])
+      provider.options.update(:release_number => "1234")
+      provider.options.update(:draft => true)
+
+      allow(provider).to receive(:slug).and_return("foo/bar")
+
+      allow(provider.api).to receive(:release)
+      allow(provider.api.release).to receive(:rels).and_return({:assets => nil})
+      allow(provider.api.release.rels[:assets]).to receive(:get).and_return({:data => nil})
+      allow(provider.api.release.rels[:assets].get).to receive(:data).and_return([])
+
+      expect(provider.api).to receive(:upload_asset).with("https://api.github.com/repos/foo/bar/releases/1234", "bar.txt", {:name=>"bar.txt", :content_type=>"text/plain"})
+      expect(provider.api).to receive(:update_release).with(anything, hash_including(:draft => true))
+
+      provider.push_app
+    end
+  end
+end

metadata

@@ -0,0 +1,187 @@
+--- !ruby/object:Gem::Specification
+name: dpl-releases
+version: !ruby/object:Gem::Version
+  version: 1.9.0
+platform: ruby
+authors:
+- Konstantin Haase
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-03-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dpl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.9.0
+- !ruby/object:Gem::Dependency
+  name: octokit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.6.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.6.2
+- !ruby/object:Gem::Dependency
+  name: mime-types
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.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: rspec-its
+  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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json_pure
+  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: tins
+  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: coveralls
+  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: highline
+  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: deploy tool abstraction for clients
+email: konstantin.mailinglists@googlemail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- dpl-releases.gemspec
+- lib/dpl/provider/releases.rb
+- spec/provider/releases_spec.rb
+homepage: https://github.com/travis-ci/dpl
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: deploy tool
+test_files:
+- spec/provider/releases_spec.rb