git_notified_on_trello 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5d40138fe5bfebe845e82969b6c1c0421079a011
-  data.tar.gz: bcc8b5e596474bcf89930790e4d748ad8c7ec2e8
+  metadata.gz: f179eca101f5089f27be964a69d56f54519be24f
+  data.tar.gz: 48854e79435d079fe6fc689334e8b9b1c6384ead
 SHA512:
-  metadata.gz: 3905bd923f14cb935db699887be954133d527b31bb314ae56316d033d99617317625bc4f3349c0c4f4a82aa89f02690f482f7405bfebf61017419e6a21a5b7a5
-  data.tar.gz: 1fa46db39ff0c08deb1c75d63b9816c4ddb7b93f2981c27ee371bd003381e9f2955b6d764d8c3331655493c2f5d3577efe446a41779a51408926933d97e5e35c
+  metadata.gz: fbfedf4988898b7fdc1f85a9e68f95fa54e85de0b9bebb163ba114ae9afcaab897014fde11f9075d0a108d1755a7e0e4bcd1d6d22108fec3c7c3d3042ff69439
+  data.tar.gz: 4d12fd2ac71d5c9a832dac137e9bd92e1a51d35ae8edea6a71395ae6b633997e7116ccd8997113e12f5dbf29d9819fc6bf2c9317d5c1617825308719a690019e

data/.travis.yml

@@ -11,11 +11,11 @@ cache:
 
 install: bundle install --jobs=3 --retry=3
 
-deploy:
-  provider: rubygems
-  api_key: "38d57d2ad2520318f2155c1cc717925f"
-  gem:
-    master: git_notified_on_trello
-  on:
-    tags: true
-    branch: master
+#deploy:
+#  provider: rubygems
+#  api_key: "38d57d2ad2520318f2155c1cc717925f"
+#  gem:
+#    master: git_notified_on_trello
+#  on:
+#    tags: true
+#    branch: master

data/README.md

@@ -4,36 +4,89 @@ git_notified_on_trello
 Get notified of pushes to a Git Repo with updates to relevant Trello cards
 
 
-Setup
------
+### Setup ###
 
-https://trello.com/1/authorize?key=YOUR_API_KEY&name=YOUR_APP_NAME&response_type=token&scope=read,write,account&expiration=never
--
+To enable posting to Trello, you must get authorization to post on behalf of a user.
 
+Trello makes this very easy. 
 
-### TODO ###
+You can read more on the [Trello API Documentation](https://trello.com/docs/) pages, but here's the quick-start:
+
+
+1. Generate (or view it if you've already created one) your developer key [https://trello.com/1/appKey/generate](https://trello.com/1/appKey/generate) 
+
+2. Generate a consumer key / member token 
+    - Replace YOUR_API_KEY with the key received above
+    - Replace YOUR_APP_NAME with the friendly name you'd like to display to users
+    - Modify *scope* and *expiration* for your needs
+    
+    Template: https://trello.com/1/authorize?key=YOUR_API_KEY&name=YOUR_APP_NAME&response_type=token&scope=read,write,account&expiration=never
+    
+    More information can be found on Trello [Getting a Token From a User](https://trello.com/docs/gettingstarted/index.html#getting-a-token-from-a-user)
+
+
+Here's a wizard that'll walk you through generating the URL:
+
+```bash
+curl -sSfL https://raw.githubusercontent.com/smj10j/git_notified_on_trello/master/docs/trello-get-oauth-url-wizard.sh | /bin/bash
+```
+
+ 
+
+
+### Installation ###
+
+```bash
+gem install git_notified_on_trello
+```
 
-- provide example usage
-- clean up and comment a bit
-- package into a gem
-- make idempotent 
-- make a plugin for jenkins 
-- send two separate messages 
-  - on commit, as it does now
-  - on deploy
-- style the comments with some fancy markdown
 
 
-rake install \
-DEVELOPER_KEY="16f7525a7039ee80c23365e648b8a542" \
-MEMBER_TOKEN="" \
-./bin/gnot -a "Stephen Johnson" -b "feature-git-notified-on-trello" -c "3463457" -m " Is it useful?\n\nhttps://trello.com/c/hR3cSUiu/1189-git-trello-plugin \nLine break on the shell like a normal commit messages would be.\n\nLet's try some *markdown*\n-------------------------\n"
+### Usage ###
 
 
+#### As a gem within your project ####
 
+```ruby
+require 'git_notified_on_trello'
+
+notifier = GitNotifiedOnTrello::Notifier.new(
+    :developer_public_key => <YOUR TRELLO DEV KEY>,
+    :member_token => <A TRELLO MEMBER TOKEN>,
+    :debug => true
+)
+notifier.notify(
+    "feature-git-notified-on-trello",                                             // Branch
+    "b7cb566c2310697f401c51433dce6b6399429fdb",                                   // Commit hash
+    "Stephen Johnson",                                                            // Commit author
+    "Updated the readme per https://trello.com/c/hR3cSUiu/1189-git-trello-plugin" // Commit message
+)
+```
+
+
+
+#### On the command-line ####
+
+```bash
+DEVELOPER_KEY="<YOUR TRELLO DEV KEY>" \
+MEMBER_TOKEN="<A TRELLO MEMBER TOKEN>" \
+gnot \
+-b "feature-git-notified-on-trello" \
+-c "b7cb566c2310697f401c51433dce6b6399429fdb" \
+-a "Stephen Johnson" \
+-m "Updated the readme per https://trello.com/c/hR3cSUiu/1189-git-trello-plugin"
+```
+
+
+
+
+### TODO ###
 
-# Get consumer key by calling
-# https://trello.com/1/authorize?key=16f7525a7039ee80c23365e648b8a542&name=Git%20Notified%20on%20Trello&response_type=token&scope=read,write,account&expiration=never
+- Clean up and comment a bit
+- Make idempotent and add function to watch a git repo for commits  
+- Make a plugin for Jenkins 
+- Send two separate messages 
+  - On commit, as it does now
+  - On deploy
+- Add tests...
 
-# If you'd like to use your own application, replace the above with this:
-# https://trello.com/1/authorize?key=YOUR_API_KEY&name=YOUR_APP_NAME&response_type=token&scope=read,write,account&expiration=never

data/deploy.sh

@@ -0,0 +1,43 @@
+#!/bin/bash
+
+VERSION_FILE="lib/git_notified_on_trello/version.rb"
+
+# Extract the version into something we can work with
+V=$(cat "$VERSION_FILE" | awk '/VERSION/ {print $3}' | tr -d '"')
+VERSION=${V:0:1}
+MAJOR=${V:2:1}
+MINOR=${V:4:1}
+
+# Do the version bump
+if [[ $MINOR -lt 9 ]]; then
+    MINOR=$(( $MINOR + 1 ))
+elif [[ $MAJOR -lt 9 ]]; then
+    MINOR=0
+    MAJOR=$(( $MAJOR + 1 ))
+else
+    MINOR=0
+    MAJOR=0
+    VERSION=$(( $VERSION + 1 ))
+fi
+
+# Get the version back into a string
+TAG="$VERSION.$MAJOR.$MINOR"
+echo "Releasing gem with tag $TAG"
+
+# Update the version file
+sed -i 's/\(.*\)VERSION = .*/\1VERSION = "'$TAG'"/' "$VERSION_FILE"
+
+# Commit the changes for the bump
+git add $VERSION_FILE
+git commit -m "Release $TAG"
+git push
+
+# Tag the release
+git tag "$TAG"
+git push --tags
+
+# Make it so
+rake release
+
+
+echo "Done!"

data/docs/trello-get-oauth-url-wizard.sh

@@ -0,0 +1,34 @@
+#!/bin/bash
+
+echo -n "Press any key to open Trello. Log in if prompted, copy your developer API key, and return to this window."
+read -e < /dev/tty
+open https://trello.com/1/appKey/generate
+
+echo -n "Paste your developer key: "
+read -e developer_key < /dev/tty
+
+echo -n "Friendly app name: "
+read -e app_name < /dev/tty
+
+echo -n "Scope (default: read,write,account): "
+read -e scope < /dev/tty
+
+echo -n "Expiration (default: never): "
+read -e expiration < /dev/tty
+
+url="https://trello.com/1/authorize?\
+key=${developer_key}&\
+name=$(echo $app_name | perl -lpe 's/([^A-Za-z0-9])/sprintf("%%%02X", ord($1))/seg')&\
+response_type=token&\
+scope=${scope:=read,write,account}&\
+expiration=${expiration:=never}"
+echo ""
+echo "URL to direct users to when asking for authorization: $url"
+echo ""
+echo -n "Press any key to open the URL in your browser."
+read -e < /dev/tty
+open "$url"
+
+echo ""
+echo "Goodbye!"
+echo ""

data/git_notified_on_trello.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Stephen Johnson"]
   spec.email         = ["steve@01j.me"]
   spec.summary       = %q{Get notified of pushes to a Git Repo with updates to relevant Trello cards}
-  spec.description   = %q{Makes Trello more useful when managing software development teams}
+  spec.description   = %q{Makes Trello more useful when managing software development teams by increasing two-way communication}
   spec.homepage      = "https://github.com/smj10j/git_notified_on_trello"
   spec.license       = "MIT"
 
@@ -18,9 +18,9 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", ">= 1.6.9"
-  spec.add_development_dependency "rake", ">= 10.0"
-  spec.add_development_dependency "rspec", ">= 3.1"
+  spec.add_development_dependency "bundler", ">= 1.6.9", "< 1.8.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.1"
 
   spec.add_runtime_dependency "ruby-trello", '~> 1.1.2'
   spec.add_runtime_dependency "trollop", '~> 2.0'

data/lib/git_notified_on_trello.rb

@@ -5,6 +5,7 @@
 #
 
 require 'trello'
+require 'git_notified_on_trello/version'
 
 module GitNotifiedOnTrello
 

data/lib/git_notified_on_trello/version.rb

@@ -1,3 +1,3 @@
 module GitNotifiedOnTrello
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/lib/git_notified_on_trello_spec.rb

@@ -1,8 +1,14 @@
 require 'spec_helper'
 
 describe GitNotifiedOnTrello do
+
   it "expects the notifier instantiation to succeed" do
     n = GitNotifiedOnTrello::Notifier.new
     expect(n).to be_a GitNotifiedOnTrello::Notifier
   end
+
+  it "must be defined" do
+    expect(GitNotifiedOnTrello::VERSION).to_not be_nil
+  end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: git_notified_on_trello
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Stephen Johnson
@@ -17,6 +17,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.6.9
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.8.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -24,32 +27,35 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.6.9
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.8.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.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.1'
 - !ruby/object:Gem::Dependency
@@ -80,7 +86,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
-description: Makes Trello more useful when managing software development teams
+description: Makes Trello more useful when managing software development teams by
+  increasing two-way communication
 email:
 - steve@01j.me
 executables:
@@ -95,6 +102,8 @@ files:
 - README.md
 - Rakefile
 - bin/gnot
+- deploy.sh
+- docs/trello-get-oauth-url-wizard.sh
 - git_notified_on_trello.gemspec
 - lib/git_notified_on_trello.rb
 - lib/git_notified_on_trello/version.rb