pt_logger 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1 @@
+--colour

data/.rvmrc

@@ -0,0 +1 @@
+rvm use 1.9.3@pt_logger --create

data/.travis.yml

@@ -0,0 +1,11 @@
+# These are specific configuration settings required for travis-ci
+# see http://travis-ci.org/evendis/pt_logger
+language: ruby
+rvm:
+  # - 1.8.7
+  # - 1.9.2
+  - 1.9.3
+  # - rbx-18mode
+  # - rbx-19mode
+  # - jruby-18mode
+  # - jruby-19mode

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in pt_logger.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,10 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec', :version => 2, :all_on_start => false, :all_after_pass => false do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/pt_logger/(.+)\.rb$})   { |m| "spec/unit/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+
+end
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Paul Gallagher
+
+MIT License
+
+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,73 @@
+# PtLogger [![Build Status](https://secure.travis-ci.org/evendis/pt_logger.png?branch=master)](http://travis-ci.org/evendis/pt_logger)
+
+PtLogger is a simple way to log messages to Pivotal tracker stories.
+
+The main motivation for this is for situations where you may be facing an as-yet unreproduceable
+bug or issue and you want to collect more specific information, possibly even from production environments.
+
+What you might do is add some special instrumentation and logging. But instead of having to go check the
+log files every so often, wouldn't it be nice if the information you are collecting gets automatically added
+to the related Pivotal Tracker story you are working on?
+
+That's what PtLogger is for.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'pt_logger'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install pt_logger
+
+## Contributing
+
+1. Fork it
+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
+
+## How to run tests
+
+Test are implemented using rspec. Run tests with <tt>rake</tt> or <tt>rake spec</tt>.
+
+[Guard](https://rubygems.org/gems/guard) is installed as part of the development dependencies,
+so to start continuous test execution on file change, start it up with <tt>bundle exec guard</tt>.
+
+# The PtLogger Cookbook
+
+## How to configure PtLogger
+
+Configuration is done using a setup block. In a Rails application, you would normally do this in
+and initializer e.g. config/initializers/pt_logger.rb
+
+    PtLogger.setup do |config|
+      config.api_key = 'xxxxx'
+      config.project_id = 'yyyyy'
+    end
+
+The API Key and PT project settings are global in nature. It is explicity assumed that all logging
+within the project should be done with a single API Key and to the same project.
+
+NB: there currently isn't a generator to make a config file for you
+
+## How to log a message with explicit story ID parameter
+
+    message_text = "this is whatever you want to log. It must be a string or support a :to_s method"
+    story_id = "1234"
+    PtLogger.log(message_text,story_id)
+
+## How to log a message with implicit story ID
+
+If the PT story ID is not passed as an explicit parameter to the <tt>log</tt> method,
+PtLogger will attempt to find a story ID in the message text itself.
+The story ID may either be prefixed with "#" or "PT:", for example:
+
+    PtLogger.log("logging a message to PT:123456 (i.e. this will be added to Pivotal Tracker story number 123456)")
+    PtLogger.log("alternatively #78910 (i.e. this will be added to Pivotal Tracker story number 78910)")

data/Rakefile

@@ -0,0 +1,24 @@
+require "bundler/gem_tasks"
+require 'rspec'
+require 'rspec/core/rake_task'
+
+desc "Run all test examples"
+RSpec::Core::RakeTask.new do |t|
+  t.rspec_opts = ["-c", "-f progress"]
+  t.pattern = 'spec/**/*_spec.rb'
+end
+
+task :default => :spec
+
+require 'rdoc/task'
+RDoc::Task.new do |rdoc|
+  rdoc.main = "README.md"
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "PT Logger"
+  rdoc.rdoc_files.include('README*', 'lib/**/*.rb')
+end
+
+desc "Open an irb session preloaded with this library"
+task :console do
+  sh "irb -rubygems -I lib -r pt_logger.rb"
+end

data/lib/pt_logger/base.rb

@@ -0,0 +1,9 @@
+module PtLogger
+
+  def self.log(message,story_id=nil)
+    if pt = PtLogger::Logger.new
+      pt.append_story_note(message,story_id)
+    end
+  end
+
+end

data/lib/pt_logger/config.rb

@@ -0,0 +1,12 @@
+module PtLogger
+
+  # Pivotal Tracker credentials
+  mattr_accessor :api_key
+  mattr_accessor :project_id
+
+  # Default way to setup. Yields a block that gives access to all the config variables.
+  def self.setup
+    yield self
+  end
+
+end

data/lib/pt_logger/logger.rb

@@ -0,0 +1,60 @@
+class PtLogger::Logger
+
+  def initialize
+    PivotalTracker::Client.use_ssl = true
+    PivotalTracker::Client.token = api_key
+  end
+
+  def env
+    Rails.env
+  rescue
+  end
+
+  def api_key
+    PtLogger.api_key
+  end
+
+  def project_id
+    PtLogger.project_id
+  end
+
+  def project
+    @project ||= if project_id
+      PivotalTracker::Project.find(project_id)
+    end
+  end
+
+  # Command: appends +message+ to PT story +story_id+.
+  # Does nothing if +story_id+ not defined
+  #
+  # If story_id is :infer or nil: looks for a story ID in the message (either #999999999 or PT:999999999 )
+  #
+  def append_story_note(message,story_id=nil)
+    if (story_id ||= :infer) == :infer
+      story_id = extract_story_id_from(message)
+    end
+    return unless story_id
+    send_story_note!("[#{prepend_text}] #{message}",story_id)
+  end
+
+  def extract_story_id_from(message)
+    if matches = /(PT:|#)(\d+)(\s|$)/i.match(message)
+      if matches.size > 3
+        matches[2].to_i
+      end
+    end
+  end
+
+  def prepend_text
+    ['PtLogger',env].compact.join('::')
+  end
+
+  # sends the prepared +message+ as a note on +story_id+
+  def send_story_note!(message,story_id)
+    return unless project
+    if story = project.stories.find(story_id)
+      story.notes.create(:text => message, :noted_at => Time.now)  # add a new note
+    end
+  end
+
+end

data/lib/pt_logger/version.rb

@@ -0,0 +1,3 @@
+module PtLogger
+  VERSION = "0.0.1"
+end

data/lib/pt_logger.rb

@@ -0,0 +1,7 @@
+require "active_support/core_ext"
+require "pivotal-tracker"
+
+require "pt_logger/version"
+require "pt_logger/config"
+require "pt_logger/base"
+require "pt_logger/logger"

data/pt_logger.gemspec

@@ -0,0 +1,32 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pt_logger/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "pt_logger"
+  gem.version       = PtLogger::VERSION
+  gem.authors       = ["Paul Gallagher"]
+  gem.email         = ["gallagher.paul@gmail.com"]
+  gem.description   = %q{Simple way to log messages to Pivotal tracker stories}
+  gem.summary       = %q{Provides a simple interface for logging infomation on a Pivotal Tracker story. Optionally integrates with Rails logger.}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_runtime_dependency(%q<activesupport>, [">= 3.0.3"])
+  gem.add_runtime_dependency(%q<pivotal-tracker>, [">= 0.5.10"])
+
+  gem.add_development_dependency(%q<bundler>, ["> 1.1.0"])
+  gem.add_development_dependency(%q<rake>, ["~> 0.9.2.2"])
+  gem.add_development_dependency(%q<rspec>, ["~> 2.8.0"])
+  gem.add_development_dependency(%q<rdoc>, ["~> 3.11"])
+  gem.add_development_dependency(%q<guard-rspec>, ["~> 1.2.0"])
+  gem.add_development_dependency(%q<rb-fsevent>, ["~> 0.9.1"])
+  gem.add_development_dependency(%q<vcr>, ["~> 2.4"])
+  gem.add_development_dependency(%q<webmock>, ["~> 1.9.0"])
+
+end

data/spec/fixtures/cassettes/PtLogger/with_embedded_story_id/logs_successfully.yml

@@ -0,0 +1,236 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://www.pivotaltracker.com/services/v3/projects/703897
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - ! '*/*; q=0.5, application/xml'
+      Accept-Encoding:
+      - gzip, deflate
+      X-Trackertoken:
+      - <API_KEY>
+      Content-Type:
+      - application/xml
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: !binary |-
+        T0s=
+    headers:
+      !binary "Q29udGVudC1UeXBl":
+      - !binary |-
+        YXBwbGljYXRpb24veG1sOyBjaGFyc2V0PXV0Zi04
+      !binary "VHJhbnNmZXItRW5jb2Rpbmc=":
+      - !binary |-
+        Y2h1bmtlZA==
+      !binary "U3RhdHVz":
+      - !binary |-
+        MjAw
+      !binary "WC1Qb3dlcmVkLUJ5":
+      - !binary |-
+        UGh1c2lvbiBQYXNzZW5nZXIgKG1vZF9yYWlscy9tb2RfcmFjaykgMy4wLjE0
+      !binary "U2V0LUNvb2tpZQ==":
+      - !binary |-
+        dF9zZXNzaW9uPUJBaDdDRG9QWlhod2FYSmxjMTloZEVsMU9nbFVhVzFsRFZK
+        TkhJQ2IlMkY4TGNCam9mUUcxaGNuTm9ZV3hmZDJsMGFGOTFkR05mWTI5bGNt
+        TnBiMjVHT2c5elpYTnphVzl1WDJsa0lpVmlZelF5WmpNNE9XTmxNalJpTnpZ
+        Mk9Ua3pNVGs1WW1Jd01qQTVOV0l4WlRvUVgyTnpjbVpmZEc5clpXNGlNV3Ny
+        UkZWQ2VHeEJVbWQ0YlZoQ1FrTkpVa0pzVXprMGRrNU9XblpMUm5Wb1FXcDZO
+        MUJrVEZkcWRUQTktLWM1YjNlMTkzZjdlMjAyMmU4YzY4NzZhYmQ2NjAwYzg2
+        YjZjMTg0MDc7IHBhdGg9Lzsgc2VjdXJlOyBIdHRwT25seQ==
+      !binary "RXRhZw==":
+      - !binary |-
+        IjAyNGYyYzhmNDlkYmI5OWQ1OTQwNGRhMWRmMzE0YzQxIg==
+      !binary "Q2FjaGUtQ29udHJvbA==":
+      - !binary |-
+        cHJpdmF0ZSwgbWF4LWFnZT0wLCBtdXN0LXJldmFsaWRhdGU=
+      !binary "WC1SdW50aW1l":
+      - !binary |-
+        OTA=
+      !binary "U2VydmVy":
+      - !binary |-
+        bmdpbngvMS4yLjIgKyBQaHVzaW9uIFBhc3NlbmdlciAzLjAuMTQgKG1vZF9y
+        YWlscy9tb2RfcmFjayk=
+      !binary "Q29udGVudC1FbmNvZGluZw==":
+      - !binary |-
+        Z3ppcA==
+    body:
+      encoding: ASCII-8BIT
+      string: !binary |-
+        H4sIAAAAAAAAA4VUS4+bMBC+769AnNM1kKj7kNfbHtqoh2pX6vZsOTABd42N
+        bJM0/75jAyHJdlsJCfubb97joY+/W5XswDpp9EOaX2dpAro0ldT1Q/rz5euH
+        2/SRXdHOml9QenaVJFRW7CZb3t7dUILHgGjRAlsb1HnS3zQl8R6pHqzwaJor
+        0LVvEn/o4CGV2kMNNmU5mrigRL09wCt3XljPK3Fg343GHyUXcGB26NVzVwoF
+        LFvki2KxpOQUDCRRlqbXnn3Zga6ko2QCgnArrfN8DmNw62ULY7SV8BCuKSuy
+        fEmyFcnyJMvu45f8WL9Q8r6NmE7ZWwsY5uxE9+0G7F/K8R412gEtNgq4F+7V
+        jbobYxQInTJve6DklBFVdqBMKf0BS9QAduUz9lrUkJhtskyO8WBJLomncU8y
+        lmeUTBEewcCUWnopFD9jvgEDc8icmy2vjIa5JI57w11j9iwvcIJiff7FCraU
+        2IByjJLxMGDYTVF6uQtZC/9+E1dJVtznq/tVMTRRiXPNWD+hlNmjGS/KpsUe
+        urHQb/HA7vqNkiXbCuWwGeMtCHoHvPG+c5NsBoJ409eOC13xsjEW8GiBg8Oh
+        Ez50fFL6Hy2YKk3bSs9bUx3VTqFAaSEU1zWym6ZIWCsOaUj4TDwACOE7Lz5m
+        xaq4m958ZHZoxeiJhQC0QipWY3FE3YC97kSvPtUBvMYgcDyjPLqJBuKieEZS
+        sp505u0xcsYpcux5jc6HOXPHyMh5DNTic2BPew2WkngeciJzzrGtJ/doCwcY
+        V9Kwq94WJfidxbgOyXEf/gHwU9T2QQUAAA==
+    http_version: 
+  recorded_at: Wed, 03 Apr 2013 18:55:12 GMT
+- request:
+    method: get
+    uri: https://www.pivotaltracker.com/services/v3/projects/703897/stories/47387051
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - ! '*/*; q=0.5, application/xml'
+      Accept-Encoding:
+      - gzip, deflate
+      X-Trackertoken:
+      - <API_KEY>
+      Content-Type:
+      - application/xml
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: !binary |-
+        T0s=
+    headers:
+      !binary "Q29udGVudC1UeXBl":
+      - !binary |-
+        YXBwbGljYXRpb24veG1sOyBjaGFyc2V0PXV0Zi04
+      !binary "VHJhbnNmZXItRW5jb2Rpbmc=":
+      - !binary |-
+        Y2h1bmtlZA==
+      !binary "U3RhdHVz":
+      - !binary |-
+        MjAw
+      !binary "WC1Qb3dlcmVkLUJ5":
+      - !binary |-
+        UGh1c2lvbiBQYXNzZW5nZXIgKG1vZF9yYWlscy9tb2RfcmFjaykgMy4wLjE0
+      !binary "RXRhZw==":
+      - !binary |-
+        IjQ5ZjgyMDQzODM2MjgzNzFiOTI0ZDY0NDhiYzAyOWE4Ig==
+      !binary "Q2FjaGUtQ29udHJvbA==":
+      - !binary |-
+        cHJpdmF0ZSwgbWF4LWFnZT0wLCBtdXN0LXJldmFsaWRhdGU=
+      !binary "WC1SdW50aW1l":
+      - !binary |-
+        Njc=
+      !binary "U2V0LUNvb2tpZQ==":
+      - !binary |-
+        dF9zZXNzaW9uPUJBaDdDRG9QWlhod2FYSmxjMTloZEVsMU9nbFVhVzFsRFZK
+        TkhJRHR5dGJjQmpvZlFHMWhjbk5vWVd4ZmQybDBhRjkxZEdOZlkyOWxjbU5w
+        YjI1R09nOXpaWE56YVc5dVgybGtJaVV3WW1KaE9HWTRaRE16WVRFM1pHSTBN
+        REF5WmpFMU9EZGpZV1EwT1dJeE56b1FYMk56Y21aZmRHOXJaVzRpTVdGd1N5
+        dGhXRVJNVTNkbVJVWTJaRXBZUTAweUwySmhWRFZ6TlZOTFJIaENiSGhRVldw
+        cGFrRjRPR2M5LS1jZjljYjViYWYxNWQ4Yjc1ZWQ5Yjg5MzRjNzQzMDJhMGUz
+        OTdlMTFkOyBwYXRoPS87IHNlY3VyZTsgSHR0cE9ubHk=
+      !binary "U2VydmVy":
+      - !binary |-
+        bmdpbngvMS4yLjIgKyBQaHVzaW9uIFBhc3NlbmdlciAzLjAuMTQgKG1vZF9y
+        YWlscy9tb2RfcmFjayk=
+      !binary "Q29udGVudC1FbmNvZGluZw==":
+      - !binary |-
+        Z3ppcA==
+    body:
+      encoding: ASCII-8BIT
+      string: !binary |-
+        H4sIAAAAAAAAA81VS4+bMBC+51dY3De2eSwPOd5b99JDpKanqopcmAVawNSY
+        zebf1zbQZBVVW2n3gMSBeXzj+WbGY/bw0jboGdRQy27n0S3xEHS5LOqu3Hlf
+        D5/uEu+Bb9igpTrzDUKsLpA+97Dz6k5DCcrjYRwkMYkow3XhXHolf0Kuj7eu
+        MQmSNGb44uEALvrRhuV5JRUwfKWxDqNqeKV1n2F8Op22ff0stWi0EvkvUNtc
+        thMAD5U84Us+Fmbh+agUdPo4aKGBj92QV1CMDRQMvzZZ5wKGXNW9NgXhDF9L
+        1tqJFvhef5al4Y40DBoUw05rzQp+j1ZXHH+c+V6MDXoUTSPKynq9Mrq8FJiE
+        iqPQc00LI+q6BY/7hAaYhOZDhGZRnBGKvjweTMJ/Me7AsbeYN0P4GQ2z0J9C
+        XDAuRCcNjTkBoZQ4e1Y9G6ZfI9w2MyR+kKZRuvTdYTS8aP5tKdB3JFyNUAvD
+        IEpAT9IUrQK0P2RLm5DrNcMO6Q42YcSozSDcVHBWL1428zepm+olhv1EfUHM
+        DLGV/5ttSIJ47Wz9jPhZSD6E7X0QrLy3hm2URfPNeGdvU98spmmDrXSSDds0
+        o/Mlfh9bSu+j1bOlhvCHTDINkvVP8tWC/ldvzUNjd7V5j6f3jm/+AFeapkDA
+        BwAA
+    http_version: 
+  recorded_at: Wed, 03 Apr 2013 18:55:13 GMT
+- request:
+    method: post
+    uri: https://www.pivotaltracker.com/services/v3/projects/703897/stories/47387051/notes
+    body:
+      encoding: US-ASCII
+      string: ! "<?xml version=\"1.0\"?>\n<note>\n  <text>[PtLogger] a test message
+        for the PT:47387051 story</text>\n  <noted_at>2013-04-04 02:55:13 +0800</noted_at>\n</note>\n"
+    headers:
+      Accept:
+      - ! '*/*; q=0.5, application/xml'
+      Accept-Encoding:
+      - gzip, deflate
+      X-Trackertoken:
+      - <API_KEY>
+      Content-Type:
+      - application/xml
+      Content-Length:
+      - '153'
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: !binary |-
+        T0s=
+    headers:
+      !binary "Q29udGVudC1UeXBl":
+      - !binary |-
+        YXBwbGljYXRpb24veG1sOyBjaGFyc2V0PXV0Zi04
+      !binary "VHJhbnNmZXItRW5jb2Rpbmc=":
+      - !binary |-
+        Y2h1bmtlZA==
+      !binary "U3RhdHVz":
+      - !binary |-
+        MjAw
+      !binary "WC1Qb3dlcmVkLUJ5":
+      - !binary |-
+        UGh1c2lvbiBQYXNzZW5nZXIgKG1vZF9yYWlscy9tb2RfcmFjaykgMy4wLjE0
+      !binary "TG9jYXRpb24=":
+      - !binary |-
+        aHR0cHM6Ly93d3cucGl2b3RhbHRyYWNrZXIuY29tL3NlcnZpY2VzL3YzL3By
+        b2plY3RzLzcwMzg5Ny9zdG9yaWVzLzQ3Mzg3MDUxL25vdGVzLzQwMjQ1MzE1
+      !binary "RXRhZw==":
+      - !binary |-
+        ImY1NjA5ZWFmNWVmNDQyM2M4OTNlYzdiODBmMDc5Y2RjIg==
+      !binary "Q2FjaGUtQ29udHJvbA==":
+      - !binary |-
+        cHJpdmF0ZSwgbWF4LWFnZT0wLCBtdXN0LXJldmFsaWRhdGU=
+      !binary "WC1SdW50aW1l":
+      - !binary |-
+        MTE3
+      !binary "U2V0LUNvb2tpZQ==":
+      - !binary |-
+        dF9zZXNzaW9uPUJBaDdDRG9QWlhod2FYSmxjMTloZEVsMU9nbFVhVzFsRFZK
+        TkhJQndJZXpjQmpvZlFHMWhjbk5vWVd4ZmQybDBhRjkxZEdOZlkyOWxjbU5w
+        YjI1R09nOXpaWE56YVc5dVgybGtJaVV3T1dFeU16VmtPR0poTlRFM04yVTNN
+        amczWTJKbFpURTRPVEZqWkdSbFpqb1FYMk56Y21aZmRHOXJaVzRpTVZSRlVE
+        aE9lalZoVEZwVkszbFZaMUpMY0VOcU9YcFdLMUJ4VGpob1RsbzNhbWR1VVVK
+        aWRXMUJkSE05LS1jYTE3OWFjYjY2YmM3ZjExYWYxM2ZhYTc1MzQzN2YxN2Rj
+        ODIxODhkOyBwYXRoPS87IHNlY3VyZTsgSHR0cE9ubHk=
+      !binary "U2VydmVy":
+      - !binary |-
+        bmdpbngvMS4yLjIgKyBQaHVzaW9uIFBhc3NlbmdlciAzLjAuMTQgKG1vZF9y
+        YWlscy9tb2RfcmFjayk=
+      !binary "Q29udGVudC1FbmNvZGluZw==":
+      - !binary |-
+        Z3ppcA==
+    body:
+      encoding: ASCII-8BIT
+      string: !binary |-
+        H4sIAAAAAAAAAzWPwWrDMBBE7/6KRfdWki2RYGTl1lx6MNQ9lVJEtZEFtlWk
+        TUn+vrZJYQ7L8GaZMafbPMEv5hLT0jH5LBjg8p18XELH3oeXpyM72cosidBW
+        ACZ6oPsPdiwuhAEzs0rUSjdSGx79jhDeyH709JrCCnyCA8JCMGMpLiBcUgYa
+        EfqhVYfmeBBaQqGU74bvye2Fu9KYsu3ddYKzmyYXRsyGP+yN2Ar5L0ePNt4R
+        UpyR2VrIhgu1CkTdat1KBW/nwfD/xLpmv231Bw4ua0z9AAAA
+    http_version: 
+  recorded_at: Wed, 03 Apr 2013 18:55:14 GMT
+recorded_with: VCR 2.4.0

data/spec/integration/base_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+describe PtLogger do
+  let(:resource_class) { PtLogger }
+
+  before do
+    set_test_credentials
+  end
+
+  context "with embedded story id", :vcr do
+    let(:message) { "a test message for the PT:#{test_story_id} story" }
+    subject { resource_class.log(message) }
+    it "logs successfully" do
+      should be_a(PivotalTracker::Note)
+    end
+  end
+
+end

data/spec/integration/credentials_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+describe "Test Credentials" do
+  real_credentials_available?
+end

data/spec/spec_helper.rb

@@ -0,0 +1,35 @@
+require 'pt_logger'
+
+require 'vcr'
+VCR.configure do |c|
+  c.cassette_library_dir = "spec/fixtures/cassettes"
+  c.hook_into               :webmock
+  c.configure_rspec_metadata!
+  c.filter_sensitive_data('<API_KEY>') { (ENV['TEST_PTLOGGER_API_KEY'] || 'fakeapikey') }
+end
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+
+  # == Mock Framework
+  #
+  # If you prefer to use mocha, flexmock or RR, uncomment the appropriate line:
+  #
+  # config.mock_with :mocha
+  # config.mock_with :flexmock
+  # config.mock_with :rr
+  config.mock_with :rspec
+
+  # Remove this line if you're not using ActiveRecord or ActiveRecord fixtures
+  # config.fixture_path = "#{::Rails.root}/spec/fixtures"
+
+  # If you're not using ActiveRecord, or you'd prefer not to run each of your
+  # examples within a transaction, remove the following line or assign false
+  # instead of true.
+  # config.use_transactional_fixtures = true
+
+end

data/spec/support/credentials_helper.rb

@@ -0,0 +1,54 @@
+module CredentialsHelper
+
+  # Command: sets test PT credentials
+  def set_test_credentials
+    PtLogger.setup do |config|
+      config.api_key = test_api_key
+      config.project_id = test_project_id
+    end
+  end
+
+  # Returns true if real PT credentials have been configured
+  def real_credentials_available?
+    if real_api_key
+      STDERR.puts %{
+NOTE: real PT credentials are configured so if the integration tests are missing request cassettes,
+live queries will be performed to record the actual interaction.
+      }
+      true
+    else
+      STDERR.puts %{
+NOTE: real PT credentials are not configured so if the integration tests are missing request cassettes,
+they will fail. Set real PT credentials with environment variables:
+
+  export TEST_PTLOGGER_API_KEY=your_api_key
+
+      }
+      false
+    end
+  end
+
+  # Returns the API Key to use for tests
+  def test_api_key
+    real_api_key || 'fakeapikey'
+  end
+  def real_api_key
+    ENV['TEST_PTLOGGER_API_KEY']
+  end
+
+  # Returns the project ID to use for tests
+  def test_project_id
+    '703897'
+  end
+
+  # Returns the story ID to use for tests
+  def test_story_id
+    '47387051'
+  end
+
+end
+
+RSpec.configure do |conf|
+  conf.extend CredentialsHelper
+  conf.include CredentialsHelper
+end

data/spec/unit/base_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe PtLogger do
+  let(:resource_class) { PtLogger }
+  let(:logger_class) { PtLogger::Logger }
+
+  describe "##log" do
+    subject { resource_class.log(message) }
+    context "when story_id is defined in the message" do
+      let(:message) { "test message for story #12345678" }
+      let(:expected_message) { "[PtLogger] test message for story #12345678" }
+      let(:expected_story_id) { 12345678 }
+      it "should not call send_story_note!" do
+        logger_class.any_instance.should_receive(:send_story_note!).with(expected_message,expected_story_id).and_return(nil)
+        subject
+      end
+    end
+    context "when story_id is not defined" do
+      let(:message) { "test message without ID" }
+      it "should not call send_story_note!" do
+        logger_class.any_instance.should_receive(:send_story_note!).never
+        subject
+      end
+    end
+  end
+
+end

data/spec/unit/config_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+describe PtLogger do
+  let(:resource) { PtLogger }
+
+  ['api_key','project_id'].each do |string_config_option|
+    describe "##{string_config_option}" do
+      subject { resource.send(string_config_option) }
+
+      let(:expected) { 'somthing' }
+      before do
+        resource.send("#{string_config_option}=",expected)
+      end
+      it { should eql(expected) }
+
+    end
+  end
+
+  describe "##setup" do
+    let(:api_key) { 'somthing' }
+    before do
+      resource.setup do |config|
+        config.api_key = api_key
+      end
+    end
+    subject { resource }
+    its(:api_key) { should eql(api_key) }
+  end
+
+end

data/spec/unit/logger_spec.rb

@@ -0,0 +1,90 @@
+require 'spec_helper'
+
+describe PtLogger::Logger do
+
+  let(:resource_class) { PtLogger::Logger }
+  let(:instance) { resource_class.new }
+
+  context "when configured" do
+    let(:api_key)    { 'somthing' }
+    let(:project_id) { 'somthingelse' }
+
+    before do
+      PtLogger.setup do |config|
+        config.api_key    = api_key
+        config.project_id = project_id
+      end
+    end
+
+    describe "#api_key" do
+      subject { instance.api_key }
+      it { should_not be_nil }
+    end
+
+    describe "#project_id" do
+      subject { instance.project_id }
+      it { should_not be_nil }
+    end
+
+    describe "#project" do
+      let(:mock_project) { mock() }
+      before do
+        PivotalTracker::Project.stub(:find).and_return(mock_project)
+      end
+      subject { instance.project }
+      it { should eql(mock_project) }
+    end
+
+  end
+
+  describe "#extract_story_id_from" do
+    subject { instance.extract_story_id_from(message) }
+    [
+      { given: 'contains no story ref', expect: nil},
+      { given: 'contains #12 ref', expect: 12},
+      { given: 'contains at end of string #123', expect: 123},
+      { given: '#1234 contains at start of string', expect: 1234},
+      { given: 'contains pt PT:12345 ref', expect: 12345},
+      { given: 'contains pt lowercase pt:123456 ref', expect: 123456},
+      { given: 'contains #1234embeded ref', expect: nil}
+    ].each do |expectations|
+      context "when given '#{expectations[:given]}'" do
+        let(:message) { expectations[:given] }
+        it { should eql(expectations[:expect]) }
+      end
+    end
+  end
+
+  describe "#append_story_note" do
+    subject { instance.append_story_note(message) }
+    context "when story_id is defined in the message" do
+      let(:message) { "test message for story #12345678" }
+      let(:expected_message) { "[PtLogger] test message for story #12345678" }
+      let(:expected_story_id) { 12345678 }
+      it "should not call send_story_note!" do
+        instance.should_receive(:send_story_note!).with(expected_message,expected_story_id).and_return(nil)
+        subject
+      end
+    end
+    context "when story_id is not defined" do
+      let(:message) { "test message without ID" }
+      it "should not call send_story_note!" do
+        instance.should_receive(:send_story_note!).never
+        subject
+      end
+    end
+    context "when story_id is defined explicitly" do
+      subject { instance.append_story_note(message,story_id) }
+      let(:message) { "test message for story #12345678" }
+      let(:story_id) { 87654321 }
+      let(:expected_message) { "[PtLogger] test message for story #12345678" }
+      let(:expected_story_id) { 87654321 }
+      it "should not call send_story_note!" do
+        instance.should_receive(:send_story_note!).with(expected_message,expected_story_id).and_return(nil)
+        subject
+      end
+    end
+  end
+
+
+end

metadata

@@ -0,0 +1,237 @@
+--- !ruby/object:Gem::Specification
+name: pt_logger
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Paul Gallagher
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.3
+- !ruby/object:Gem::Dependency
+  name: pivotal-tracker
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.5.10
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.5.10
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>'
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>'
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2.2
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.11'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+- !ruby/object:Gem::Dependency
+  name: rb-fsevent
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.4'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.9.0
+description: Simple way to log messages to Pivotal tracker stories
+email:
+- gallagher.paul@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .rvmrc
+- .travis.yml
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/pt_logger.rb
+- lib/pt_logger/base.rb
+- lib/pt_logger/config.rb
+- lib/pt_logger/logger.rb
+- lib/pt_logger/version.rb
+- pt_logger.gemspec
+- spec/fixtures/cassettes/PtLogger/with_embedded_story_id/logs_successfully.yml
+- spec/integration/base_spec.rb
+- spec/integration/credentials_spec.rb
+- spec/spec_helper.rb
+- spec/support/credentials_helper.rb
+- spec/unit/base_spec.rb
+- spec/unit/config_spec.rb
+- spec/unit/logger_spec.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Provides a simple interface for logging infomation on a Pivotal Tracker story.
+  Optionally integrates with Rails logger.
+test_files:
+- spec/fixtures/cassettes/PtLogger/with_embedded_story_id/logs_successfully.yml
+- spec/integration/base_spec.rb
+- spec/integration/credentials_spec.rb
+- spec/spec_helper.rb
+- spec/support/credentials_helper.rb
+- spec/unit/base_spec.rb
+- spec/unit/config_spec.rb
+- spec/unit/logger_spec.rb