sync_issues 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e9a86463a72523cc3da204c2be3cb67ababb8dfc
-  data.tar.gz: d08f2187e85282b976b4e7c9f506a5a8dc2df475
+  metadata.gz: 77f59d92db9bb219cd1ff88a3914d4b9fea5e917
+  data.tar.gz: f454013652d08bc68ec38a74172741e451a62db0
 SHA512:
-  metadata.gz: 2eef9c97d166350c79b265d7af1ee869faf99a73242ca01a865f37d0f2bc4240f241edbe2ffb5d04bef0fa4f26bc784b2bc4521e8e87114dadcc2152dec8d15d
-  data.tar.gz: e38af6793db30c7f58ddd6b1b3d3ba8b34d69e940c0e7979c1fec2ee010ddc6ee3ffd01d48bc54c657845e3851f2fa773d539a1f1f3b4180bc4e5523ca97af1d
+  metadata.gz: 517e439aec314cbd00a20bd268e02b1254352f8cf112eb284b8cbcc7e71c12cc50516d851c7122ad830a9bdd0aabd261f66a377f57a6ffe9d10e43f8990edc4b
+  data.tar.gz: 60af37b8b814bffea5db9d38d1e27dcde4b907cfccc35999d0ca9f944783fdacf8ad070b80612c6c1d6a3e0542e1d0531067f98ccc2338a39dd002262524faa3

data/README.md

@@ -10,11 +10,37 @@ To install sync_issues run:
 
     gem install sync_issues
 
+
+## sync_issues.yaml configuration
+
+In order to run sync_issues you will need to create a GitHub API token with the
+`public_repo` scope for creating issues only on public repositories, or the
+`repo` scope for creating issues on both private and public repositories.
+
+![Generate Access Token](img/access_token_generate.png)
+
+To create a token visit https://github.com/settings/tokens/new, and select the
+appropriate scope `repo` or `public_repo` for your projects. Then click the
+green "Generate Token" button to create the token.
+
+![New Access Token](img/access_token_new.png)
+
+Create a config file `$HOME/.config/sync_issues.yaml` with the following
+contents ensuring that you use the access token generated for you:
+
+```yaml
+token: 0beec7b5ea3f0fdbc95d0dd47f3c5bc275da8a33
+```
+
+If you lose the page with your new access token before creating
+`sync_issues.yaml`, don't fret. Delete the appropriate token, and try again.
+
+
 ## Running sync_issues
 
 Run sync_issues via:
 
-    sync_tasks /path/to/tasks/directory bboe/repo1 appfolio/repo2
+    sync_issues /path/to/tasks/directory bboe/repo1 appfolio/repo2
 
 
 ## Local Issue Directory

data/lib/sync_issues/command.rb

@@ -1,4 +1,5 @@
 require 'docopt'
+require 'octokit'
 require_relative 'error'
 require_relative 'synchronizer'
 require_relative 'version'
@@ -28,14 +29,17 @@ module SyncIssues
       handle_args(Docopt.docopt(DOC, version: VERSION))
     rescue Docopt::Exit => exc
       exit_with_status(exc.message, exc.class.usage != '')
-    rescue Error => exc
+    rescue TokenError => exc
+      exit_with_status("#{exc.message}\nPlease see:
+        https://github.com/bboe/sync_issues#sync_issuesyaml-configuration")
+    rescue Error, Octokit::Unauthorized => exc
       exit_with_status(exc.message)
     end
 
     private
 
-    def exit_with_status(msg, condition = true)
-      puts msg
+    def exit_with_status(message, condition = true)
+      puts message
       @exit_status == 0 && condition ? 1 : @exit_status
     end
 

data/lib/sync_issues/error.rb

@@ -7,4 +7,7 @@ module SyncIssues
 
   class ParseError < Error
   end
+
+  class TokenError < Error
+  end
 end

data/lib/sync_issues/github.rb

@@ -33,7 +33,10 @@ module SyncIssues
 
     def token
       path = File.expand_path('~/.config/sync_issues.yaml')
-      SafeYAML.load(File.read(path))['token']
+      raise TokenError, "#{path} does not exist" unless File.exist?(path)
+      SafeYAML.load(File.read(path))['token'].tap do |token|
+        raise TokenError, "#{path} missing token attribute" if token.nil?
+      end
     end
   end
 end

data/lib/sync_issues/synchronizer.rb

@@ -7,6 +7,7 @@ module SyncIssues
   # Synchronizer is responsible for the actual synchronization.
   class Synchronizer
     def initialize(directory, repository_names, update_only: false)
+      @github = SyncIssues.github
       @issues = issues(directory)
       @repositories = repositories(repository_names)
       @update_only = update_only
@@ -45,7 +46,7 @@ module SyncIssues
     def repositories(repository_names)
       repositories = repository_names.map do |repository_name|
         begin
-          SyncIssues.github.repository(repository_name)
+          @github.repository(repository_name)
         rescue Error => exc
           puts "'#{repository_name}' #{exc}"
           nil
@@ -61,7 +62,7 @@ module SyncIssues
       puts "Repository: #{repository.full_name}"
 
       existing_by_title = {}
-      SyncIssues.github.issues(repository.full_name).each do |issue|
+      @github.issues(repository.full_name).each do |issue|
         existing_by_title[issue.title] = issue
       end
 
@@ -81,7 +82,7 @@ module SyncIssues
         puts "Skipping create issue: #{issue.title}"
       else
         puts "Adding issue: #{issue.title}"
-        SyncIssues.github.create_issue(repository, issue)
+        @github.create_issue(repository, issue)
       end
     end
 
@@ -91,8 +92,8 @@ module SyncIssues
 
       changed = comparison.changed.join(', ')
       puts "Updating #{changed} on ##{github_issue.number}"
-      SyncIssues.github.update_issue(repository, github_issue.number,
-                                     comparison.title, comparison.content)
+      @github.update_issue(repository, github_issue.number, comparison.title,
+                           comparison.content)
     end
   end
 end

data/lib/sync_issues/version.rb

@@ -1,4 +1,4 @@
 # SyncIssues
 module SyncIssues
-  VERSION = '0.1.1'.freeze
+  VERSION = '0.2.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sync_issues
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Bryce Boe
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-04 00:00:00.000000000 Z
+date: 2016-02-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: docopt