github_flo 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 84f1c4779eae28a2884b3b74667232325dc2e91b
+  data.tar.gz: b40b8a29aed56a18f0ad1497009102843cbea4e1
+SHA512:
+  metadata.gz: 8345acf803a14ed6cb7214af7f1403862d13fc8867b7f7fa8a1a452102a5bb840160c0d11aaf6e8cacd75b9e4a970b33f0c38215e3edbc1cbbc1e42ad9b0a3f9
+  data.tar.gz: 583e18bba6df3d54d2607b811d62f40a1f2502d32c6d8474232b19d0c29d7868234e34c08bf65a1730ad02c7d414b67076009e1c9b05bd252cd8c1827c838498

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,9 @@
+# Copyright © 2017, Salesforce.com, Inc.
+# All Rights Reserved.
+# Licensed under the BSD 3-Clause license.
+# For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in github_flo.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,12 @@
+Copyright (c) 2017, Salesforce.com, Inc.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+* Neither the name of Salesforce.com nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,70 @@
+# GithubFlo
+[![Gem Version](https://badge.fury.io/rb/github_flo.svg)](https://badge.fury.io/rb/github_flo) [![Code Climate](https://codeclimate.com/github/salesforce/github_flo/badges/gpa.svg)](https://codeclimate.com/github/salesforce/github_flo) [![Build Status](https://semaphoreci.com/api/v1/justinpowers/github_flo/branches/master/shields_badge.svg)](https://semaphoreci.com/justinpowers/github_flo)
+
+GithubFlo is a Salesforce plugin for the Flo workflow automation library.  If you aren't familiar with Flo, then please start [here](https://github.com/salesforce/flo)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'github_flo'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install github_flo
+
+## Configuration
+
+In your Flo configuration file, configure salesforce inside the `config` block
+
+```ruby
+config do |cfg|
+  cfg.provider :github_flo, { user: ENV['OCTOKIT_TEST_USER'], token: ENV['OCTOKIT_TEST_TOKEN'], repo: 'salesforce/github_flo' }
+end
+```
+
+See the [Octokit gem](https://github.com/octokit/octokit.rb#authentication) for information on setting up the client.
+
+## Usage
+
+Specify the commands you wish to run in the `register_command` block.  For example
+```ruby
+# Updates a github issue
+perform :github_flo, :update_issue, { number: number, assignee: assignee }
+
+# Adds a label to an issue
+perform :github_flo, :add_labels_to_an_issue, { number: number, labels: ["Work in progress"] }
+
+# Idempotently creates a pull request 
+perform :github_flo, :create_pull_request, { base: 'master', branch: "issues/#{number}", title: "Fixes #{number}", body: 'Some important details' }
+```
+
+## Contributing
+
+1. Fork it (http://github.com/your-github-username/github_flo/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+
+## License
+
+>Copyright (c) 2017, Salesforce.com, Inc.
+>All rights reserved.
+>
+>Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+>
+>* Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+>
+>* Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+>
+>* Neither the name of Salesforce.com nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+>
+>THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/Rakefile

@@ -0,0 +1,15 @@
+# Copyright © 2017, Salesforce.com, Inc.
+# All Rights Reserved.
+# Licensed under the BSD 3-Clause license.
+# For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+
+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/github_flo.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+# Copyright © 2017, Salesforce.com, Inc.
+# All Rights Reserved.
+# Licensed under the BSD 3-Clause license.
+# For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'github_flo/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "github_flo"
+  spec.version       = GithubFlo::VERSION
+  spec.authors       = ['Justin Powers', 'John Tuley']
+  spec.email         = ['justin.powers@salesforce.com', 'jtuley@salesforce.com']
+
+  spec.summary       = %q{"Github plugin for Flo"}
+  spec.homepage      = "https://github.com/salesforce/github_flo"
+  spec.license       = "BSD-3-Clause"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^test/}) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "pry"
+
+  spec.add_dependency 'octokit', '~> 4.0.1'
+end

data/lib/flo/provider/github_flo.rb

@@ -0,0 +1,69 @@
+# Copyright © 2017, Salesforce.com, Inc.
+# All Rights Reserved.
+# Licensed under the BSD 3-Clause license.
+# For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+
+require 'octokit'
+
+module Flo
+  module Provider
+    class GithubFlo
+
+      # Creates a new GithubFlo Provider instance
+      #
+      # @param [Hash] opts The options needed to create the provider
+      # @option opts [String] :user The username of the github user
+      # @option opts [String] :token an access token for the user
+      # @option opts [String] :repo the name of the repo, e.g. 'salesforce/github_flo'
+      #
+      def initialize(opts={})
+        username = opts[:user]
+        token = opts[:token]
+        @repo = opts[:repo]
+
+        @client = opts[:client] || Octokit::Client.new(login: username, password: token)
+      end
+
+      # Updates a Github issue
+      #
+      # @param [Hash] opts Options for updating an issue
+      # @option opts [String] :number The issue number to update
+      #
+      # Remaining options will be passed to octokit.  See octokit's documentation for updating issues
+      #
+      def update_issue(opts={})
+        options = {repo: @repo}.merge(opts)
+        @client.update_issue(options.delete(:repo), options.delete(:number), options)
+        OpenStruct.new(success?: true)
+      end
+
+      # Adds labels to a Github Issue
+      #
+      # @param [Hash] opts Options for updating an issue
+      # @option opts [String] :number The issue number to update
+      # @option opts [Array<String>] :labels A list of labels to add to the issue
+      #
+      # Remaining options will be passed to octokit.  See octokit's documentation for updating issues
+      #
+      def add_labels_to_an_issue(opts={})
+        options = {repo: @repo}.merge(opts)
+        @client.add_labels_to_an_issue(options.delete(:repo), options.delete(:number), options[:labels])
+        OpenStruct.new(success?: true)
+      end
+
+      # Provides an Octokit issue.  This is helpful when you want to take some other action based on
+      # the state of an issue.
+      #
+      # @param [Hash] opts Options for finding the issue
+      # @option opts [String] :number The issue number to fetch
+      #
+      # @return [Sawyer::Resource] The issue returned from octokit
+      #
+      def issue(opts={})
+        options = {repo: @repo}.merge(opts)
+        @client.issue(options[:repo], options[:number])
+      end
+
+    end
+  end
+end

data/lib/github_flo/version.rb

@@ -0,0 +1,8 @@
+# Copyright © 2017, Salesforce.com, Inc.
+# All Rights Reserved.
+# Licensed under the BSD 3-Clause license.
+# For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+
+module GithubFlo
+  VERSION = "0.0.1"
+end

data/lib/github_flo.rb

@@ -0,0 +1,10 @@
+# Copyright © 2017, Salesforce.com, Inc.
+# All Rights Reserved.
+# Licensed under the BSD 3-Clause license.
+# For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+
+require "github_flo/version"
+
+module GithubFlo
+  # Your code goes here...
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: github_flo
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Justin Powers
+- John Tuley
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-05-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: minitest
+  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: 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: octokit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.0.1
+description: 
+email:
+- justin.powers@salesforce.com
+- jtuley@salesforce.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- github_flo.gemspec
+- lib/flo/provider/github_flo.rb
+- lib/github_flo.rb
+- lib/github_flo/version.rb
+homepage: https://github.com/salesforce/github_flo
+licenses:
+- BSD-3-Clause
+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.5.2
+signing_key: 
+specification_version: 4
+summary: '"Github plugin for Flo"'
+test_files: []