tracker_api 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 415d625d6e47d65a310da72f3a89b4c8d18cf48a
-  data.tar.gz: 02a6be2414450453a95a2a045a94e7d6d9cebc93
+  metadata.gz: 5b897caea67a6740f4ec6c0a2fffceeb581248ca
+  data.tar.gz: 709d70b6f4cd722acf7c37e87dcdd1d0a81f3185
 SHA512:
-  metadata.gz: 22c7a09d01872c391e0bd0d7ce80b0efa00cd087e20a2ecacf63e0e2a099071bcf4a826be55353629010ab65838c77a0088cb7eb241dc8b68d96983246ce3714
-  data.tar.gz: a26439fcf3b28af52c43e737978bf8da4058bb35e953fbfae3ec2794b672911d853c0c478cf804f2524a8b8f1eebdf02b6ade4a882f380d7dbb4a7dadaaa5075
+  metadata.gz: 0163e2073569220d272f6f23abca2bc2b07ed1688f0eb09131308f58a9b4307e23afce7d389377397d10d62f3d8385f781ee432dcd27331e5754682d0918b6b0
+  data.tar.gz: ac24c26685e42b4dd78af2a9a7d263ee84cacee8ebb6c0e3225e2fa7abed51bf557c737eaf1a93971f292c17370447112965ee37ea08a6769cb9b1b0ca7153f7

data/CHANGELOG.md

@@ -1,9 +1,4 @@
-0.1.0
+Changelog has moved to Releases
 ---
-- Initial release.
 
-0.2.0
----
-- Feature: Added auto pagination.
-- Bug: Added `current_velocity` attribute to `Project`.
-- Bug: Removed attributes from `Iteration` that don't exist.
+Please see [Releases](https://github.com/dashofcode/tracker_api/releases) for changes.

data/README.md

@@ -10,6 +10,25 @@ This gem allows you to easily use the [Pivotal Tracker v5 API](https://www.pivot
 
 It’s powered by [Faraday](https://github.com/lostisland/faraday) and [Virtus](https://github.com/solnic/virtus).
 
+##Demonstration
+[Dash of Agile](https://www.dashofagile.com) uses `tracker_api` to create agile dashboards from Pivotal Tracker projects.
+
+## Installation
+
+Add this line to your application's Gemfile:
+```ruby
+gem 'tracker_api', '~> 0.2.0'
+```
+
+And then execute:
+```bash
+$ bundle install
+```
+
+Or install it yourself as:
+```bash
+$ gem install tracker_api
+```
 
 ## Basic Usage
 

data/lib/tracker_api/client.rb

@@ -24,7 +24,7 @@ module TrackerApi
       url                = options.fetch(:url, 'https://www.pivotaltracker.com')
       @url               = Addressable::URI.parse(url).to_s
       @api_version       = options.fetch(:api_version, '/services/v5')
-      @logger            = options.fetch(:logger, Logger.new(nil))
+      @logger            = options.fetch(:logger, ::Logger.new(nil))
       adapter            = options.fetch(:adapter, :net_http)
       connection_options = options.fetch(:connection_options, { ssl: { verify: true } })
       @auto_paginate     = options.fetch(:auto_paginate, true)

data/lib/tracker_api/resources/project.rb

@@ -40,7 +40,7 @@ module TrackerApi
       attribute :version, Integer
       attribute :week_start_day, String
 
-      # @return [String] Comma separated list of labels.
+      # @return [String] comma separated list of labels
       def label_list
         @label_list ||= labels.collect(&:name).join(',')
       end
@@ -76,13 +76,13 @@ module TrackerApi
       # @option params [Integer] :offset With the first story in your priority list as 0,
       #   the index of the first story you want returned.
       # @option params [Integer] :limit The number of stories you want returned.
-      # @return [Array[Story]] iterations associated with this project
+      # @return [Array[Story]] stories associated with this project
       def stories(params = {})
         Endpoints::Stories.new(client).get(id, params)
       end
 
-      # @param [Fixnum] story_id id of story
-      # @return [Story]
+      # @param [Fixnum] story_id id of story to get
+      # @return [Story] Story with given id
       def story(story_id)
         Endpoints::Story.new(client).get(id, story_id)
       end

data/lib/tracker_api/version.rb

@@ -1,3 +1,3 @@
 module TrackerApi
-  VERSION = '0.2.0'
+  VERSION = '0.2.1'
 end

data/test/client_test.rb

@@ -10,11 +10,13 @@ describe TrackerApi::Client do
   it 'can be configured' do
     client = TrackerApi::Client.new(url:         'http://test.com',
                                     api_version: '/foo-bar/1',
-                                    token:       '12345')
+                                    token:       '12345',
+                                    logger:      LOGGER)
 
     client.url.must_equal 'http://test.com'
     client.api_version.must_equal '/foo-bar/1'
     client.token.must_equal '12345'
+    client.logger.must_equal LOGGER
   end
 
   describe '.projects' do

data/test/minitest_helper.rb

@@ -28,3 +28,5 @@ PT_USER_1 = { project_id: 1027488, token: '0de3ac29f13082f0c16ed76f3f3f6895' } #
 PT_USER_2 = { project_id: 1027492, token: '90a51cef4e7c358b36b4e4cdf0f2dd2a' } # trackher2 user
 PT_USER_3 = { project_id: 1027494, token: 'f8aad6b471d1b1eb303d368ef533f622' } # trackher3 user
 PT_USERS  = [PT_USER_1, PT_USER_2, PT_USER_3]
+
+LOGGER = ::Logger.new(STDOUT)

data/tracker_api.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email       = ['forestcarlisle@gmail.com']
   spec.summary     = %q{API client for the Pivotal Tracker v5 API}
   spec.description = %q{This gem allows you to easily use the Pivotal Tracker v5 API.}
-  spec.homepage    = ''
+  spec.homepage    = 'https://github.com/dashofcode/tracker_api'
   spec.license     = 'MIT'
 
   spec.files         = `git ls-files`.split($/)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tracker_api
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Forest Carlisle
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-26 00:00:00.000000000 Z
+date: 2014-04-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -195,7 +195,7 @@ files:
 - test/vcr/cassettes/get_project_with_epics.json
 - test/vcr/cassettes/get_unscheduled_stories.json
 - tracker_api.gemspec
-homepage: ''
+homepage: https://github.com/dashofcode/tracker_api
 licenses:
 - MIT
 metadata: {}