circleci_artifact 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0c1a1533acb7d8f33447d4b431f40f91108b342a43c78ed965f49a8b697acb5a
+  data.tar.gz: f5991dff86c4deaa0a16b10a0891e99bccfb68fdf1429e9b258326834320a1ee
+SHA512:
+  metadata.gz: 41e65135852f1cb67a03ebc25bb006a932c46367dfbc87ec3f17b97da1ec1dcf8a2949e430071c2f1c67cd02a420c9c942409184ffeaa0af56ff5ab2f2e6cc0c
+  data.tar.gz: 01a0a710991e0491db02c77bd77886e8e0086c2f93dd7b81545a1f25b18aa15c3514ae0751ba492c33bde00987daaa06a5d8b65d65d903f53399c277b98f2d0c

data/.circleci/config.yml

@@ -0,0 +1,36 @@
+# Ruby CircleCI 2.0 configuration file
+#
+# Check https://circleci.com/docs/2.0/language-ruby/ for more details
+#
+version: 2
+jobs:
+  build:
+    docker:
+       - image: circleci/ruby:latest
+    working_directory: ~/repo
+
+    steps:
+      - checkout
+
+      # Download and cache dependencies
+      - restore_cache:
+          keys:
+          - v1-dependencies-{{ checksum "Gemfile.lock" }}
+          # fallback to using the latest cache if no exact match is found
+          - v1-dependencies-
+
+      - run:
+          name: install dependencies
+          command: |
+            bundle install --jobs=4 --retry=3 --path vendor/bundle
+
+      - save_cache:
+          paths:
+            - ./vendor/bundle
+          key: v1-dependencies-{{ checksum "Gemfile.lock" }}
+        
+      # run tests!
+      - run:
+          name: run tests
+          command: |
+            bundle exec rake test

data/.gitignore

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

data/.rubocop.yml

@@ -0,0 +1,6 @@
+
+Metrics/LineLength:
+  Max: 99
+
+Metrics/MethodLength:
+  Max: 30

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 chris.ballinger@raizlabs.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,10 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in circleci_artifact.gemspec
+gemspec
+
+gem 'rubocop', '~> 0.55.0', require: false

data/Gemfile.lock

@@ -0,0 +1,46 @@
+PATH
+  remote: .
+  specs:
+    circleci_artifact (0.1.0)
+      circleci (~> 2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    circleci (2.0.2)
+    coderay (1.1.2)
+    method_source (0.9.0)
+    minitest (5.11.3)
+    parallel (1.12.1)
+    parser (2.5.1.0)
+      ast (~> 2.4.0)
+    powerpack (0.1.1)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    rubocop (0.55.0)
+      parallel (~> 1.10)
+      parser (>= 2.5)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.9.0)
+    unicode-display_width (1.3.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  circleci_artifact!
+  minitest (~> 5.0)
+  pry
+  rake (~> 10.0)
+  rubocop (~> 0.55.0)
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Raizlabs
+
+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,80 @@
+# circleci_artifact
+
+[![CircleCI](https://img.shields.io/circleci/project/github/Raizlabs/circleci_artifact/master.svg)](https://circleci.com/gh/Raizlabs/circleci_artifact)
+
+This library is designed to make fetching the URLs for [CircleCI build artifacts](https://circleci.com/docs/2.0/artifacts/#downloading-all-artifacts-for-a-build-on-circleci) quick and easy. Unfortunately CircleCI makes it difficult to get the URLs for your build artifacts without hitting their API, so it's not straightforward to include links to your artifacts as part of the CI process.
+
+This gem was built to be used in combination with tools like [Fastlane](https://github.com/fastlane/fastlane) and [Danger](https://github.com/danger/danger). The functionality is very limited at this point, and just makes it easier to grab single artifacts whose URL match a substring.
+
+## Getting Started
+
+* Create a new CircleCI account for your CI bot user.
+* Create a CircleCI API token in the application by going to [User Settings > Personal API Tokens](https://circleci.com/account/api).
+* Create a new token called `CIRCLE_API_TOKEN`. 
+* Add `CIRCLE_API_TOKEN` to the CircleCI build environment for the target repo.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'circleci_artifact'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install circleci_artifact
+
+## Usage
+
+
+```ruby
+require 'circleci_artifact'
+
+# Set this yourself using the steps in "Getting Started"
+token = ENV['CIRCLE_API_TOKEN']
+
+# These are already in the Circle environment
+# https://circleci.com/docs/2.0/env-vars/#build-specific-environment-variables
+username = ENV['CIRCLE_PROJECT_USERNAME']
+reponame = ENV['CIRCLE_PROJECT_REPONAME']
+build = ENV['CIRCLE_BUILD_NUM']
+
+fetcher = CircleciArtifact::Fetcher.new(token: token, username: username, reponame: reponame, build: build)
+
+xcov = CircleciArtifact::Query.new(url_substring: 'xcov/index.html')
+slather = CircleciArtifact::Query.new(url_substring: 'slather/index.html')
+screenshots = CircleciArtifact::Query.new(url_substring: 'screenshots/index.html')
+queries = [xcov, slather, screenshots]
+results = fetcher.fetch_queries(queries)
+
+xcov_url = results.url_for_query(xcov)
+slather_url = results.url_for_query(slather)
+screenshots_url = results.url_for_query(screenshots)
+
+puts "xcov_url #{xcov_url}"
+puts "slather_url #{slather_url}"
+puts "screenshots_url #{screenshots_url}"
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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/Raizlabs/circleci_artifact. 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](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the CircleciArtifact project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/Raizlabs/circleci_artifact/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task default: :test

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'circleci_artifact'
+
+# 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/circleci_artifact.gemspec

@@ -0,0 +1,31 @@
+
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'circleci_artifact/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'circleci_artifact'
+  spec.version       = CircleciArtifact::VERSION
+  spec.authors       = ['Chris Ballinger']
+  spec.email         = ['chris.ballinger@raizlabs.com']
+
+  spec.summary       = 'Easy fetching of CircleCI build artifact URLs'
+  spec.homepage      = 'https://github.com/Raizlabs/circleci_artifact'
+  spec.license       = 'MIT'
+
+  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_runtime_dependency 'circleci', '~> 2.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rake', '~> 10.0'
+end

data/lib/circleci_artifact.rb

@@ -0,0 +1,164 @@
+# frozen_string_literal: true
+
+require 'circleci_artifact/version'
+require 'circleci'
+
+module CircleciArtifact
+  # Simple queries for artifacts
+  class Query
+    attr_reader :url_substring
+
+    # 'url_substring' is a resource url substring you're looking for
+    #
+    # @param   url_substring [String]
+    def initialize(url_substring:)
+      raise ArgumentError if url_substring.to_s.empty?
+      @url_substring = url_substring
+    end
+
+    def ==(other)
+      other.is_a?(self.class) &&
+        (other.url_substring == @url_substring)
+    end
+
+    alias eql? ==
+
+    def hash
+      @url_substring.hash
+    end
+  end
+
+  # Returned if query is successful
+  class Result
+    attr_reader :query, :url
+
+    # @param   query [Query]
+    # @param   url [String] the url matching the original query
+    def initialize(query:, url:)
+      raise ArgumentError unless query.is_a?(Query)
+      raise ArgumentError if url.to_s.empty?
+      @query = query
+      @url = url
+    end
+  end
+
+  # Set of all matching queries
+  class ResultSet
+    def initialize
+      @results = {}
+    end
+
+    # @param   result [Result]
+    # @return [void]
+    def add_result(result)
+      raise ArgumentError unless result.is_a?(Result)
+      results = @results[result.query] || []
+      results.push(result)
+      @results[result.query] = results
+    end
+
+    # Returns first result for query
+    #
+    # @param   query [Query]
+    # @return [Result]
+    def result_for_query(query)
+      results_for_query(query).first
+    end
+
+    # Returns all results matching query
+    #
+    # @param   query [Query]
+    # @return [Array<Result>]
+    def results_for_query(query)
+      raise ArgumentError unless query.is_a?(Query)
+      @results[query] ? @results[query] : []
+    end
+
+    # Returns first url for query
+    #
+    # @param   query [Query]
+    # @return [String]
+    def url_for_query(query)
+      result_for_query(query)&.url
+    end
+  end
+
+  # This is the main interface, handles fetching and parsing
+  class Fetcher
+    # @param   token [String]
+    # @param   username [String]
+    # @param   reponame [String]
+    # @param   build [String]
+    def initialize(token:, username:, reponame:, build:)
+      raise ArgumentError, 'Error: Missing CIRCLE_API_TOKEN' if token.to_s.empty?
+      raise ArgumentError, 'Error: Missing CIRCLE_PROJECT_USERNAME' if username.to_s.empty?
+      raise ArgumentError, 'Error: Missing CIRCLE_PROJECT_REPONAME' if reponame.to_s.empty?
+      raise ArgumentError, 'Error: Missing CIRCLE_BUILD_NUM' if build.to_s.empty?
+
+      @token = token
+      @username = username
+      @reponame = reponame
+      @build = build
+
+      @config = CircleCi::Config.new token: token
+    end
+
+    # Give array of Query to find, returns Results
+    #
+    # @param queries [Array<Query>]
+    # @return  [ResultSet]
+    def fetch_queries(queries)
+      raise ArgumentError, 'Error: Must have queries' unless queries.is_a?(Array)
+      build = CircleCi::Build.new @username, @reponame, nil, @build, @config
+      artifacts = build.artifacts
+
+      if artifacts.nil?
+        STDERR.puts 'Error: No artifacts'
+        return Results.new
+      end
+      parse(artifacts: artifacts, queries: queries)
+    end
+
+    # Internal method for extracting results
+    # @param artifacts [CircleCi::Artifacts]
+    # @param queries [Array<Query>]
+    # @return  [ResultSet]
+    def parse(artifacts:, queries:)
+      raise ArgumentError, 'Error: Must have artifacts' if artifacts.nil?
+      raise ArgumentError, 'Error: Must have queries' unless queries.is_a?(Array)
+
+      # Example
+      # [
+      #   {
+      #     node_index: 0,
+      #     path: "/tmp/circle-artifacts.NHQxLku/cherry-pie.png",
+      #     pretty_path: "$CIRCLE_ARTIFACTS/cherry-pie.png",
+      #     url: "https://circleci.com/gh/circleci/mongofinil/22/artifacts/0/tmp/circle-artifacts.NHQxLku/cherry-pie.png"
+      #   },
+      #   {
+      #     node_index: 0,
+      #     path: "/tmp/circle-artifacts.NHQxLku/rhubarb-pie.png",
+      #     pretty_path: "$CIRCLE_ARTIFACTS/rhubarb-pie.png",
+      #     url: "https://circleci.com/gh/circleci/mongofinil/22/artifacts/0/tmp/circle-artifacts.NHQxLku/rhubarb-pie.png"
+      #   }
+      # ]
+
+      results = ResultSet.new
+
+      artifacts.body.each do |artifact|
+        url = artifact['url']
+        if url.nil?
+          STDERR.puts "Warning: No URL found on #{artifact}"
+          next
+        end
+
+        query = queries.find { |q| url.include?(q.url_substring) }
+        next if query.nil?
+        result = Result.new(query: query, url: url)
+        results.add_result(result)
+      end
+
+      results
+    end
+  end
+end

data/lib/circleci_artifact/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module CircleciArtifact
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: circleci_artifact
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Chris Ballinger
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-04-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: circleci
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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'
+description: 
+email:
+- chris.ballinger@raizlabs.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".circleci/config.yml"
+- ".gitignore"
+- ".rubocop.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- circleci_artifact.gemspec
+- lib/circleci_artifact.rb
+- lib/circleci_artifact/version.rb
+homepage: https://github.com/Raizlabs/circleci_artifact
+licenses:
+- MIT
+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.7.6
+signing_key: 
+specification_version: 4
+summary: Easy fetching of CircleCI build artifact URLs
+test_files: []