pivotaltracker 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 61ac8b68150b99a9fcf1d21285a32e8ca34adab1
+  data.tar.gz: 42bf2e0a941060432bc9bf5948361a952d372ed7
+SHA512:
+  metadata.gz: c00c927724f0d363e919c49157521bce6ad13c1f9543c29cb63d0e1eeed2a8ad0e2ca90039c6bb5fdfae77123b3b075b3786394daa6baf16b00ed6cf69c7672d
+  data.tar.gz: 23b76717b114e81e3237f58a33fa607b6e3c158866f81ea5f7d2dc4f686503a292e7cd277c85b40dfaef9a45a89072bee191379911ed63c031d7d400461ec11d

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.rspec

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 2.1
+  - 2.2

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Alvaro Fernando Lara
+
+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/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Alvaro F. Lara
+
+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,53 @@
+# PivotalTracker (*.rb)
+
+Pivotal Tracker API v.5 client.
+
+[![Code
+Climate](https://codeclimate.com/github/guiman/pivotaltracker/badges/gpa.svg)](https://codeclimate.com/github/guiman/pivotaltracker)
+[![Build
+Status](https://travis-ci.org/guiman/pivotaltracker.svg)](https://travis-ci.org/guiman/pivotaltracker)
+[![Test
+Coverage](https://codeclimate.com/github/guiman/pivotaltracker/badges/coverage.svg)](https://codeclimate.com/github/guiman/pivotaltracker)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'pivotaltracker'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install pivotaltracker
+
+## Usage
+
+```
+api = PivotalTracker::API.new(configuration) do |config|
+  config.token = api_token
+end
+
+project = PivotalTracker::Project.find(project_id)
+
+stories = project.stories
+iterations = project.iterations
+
+stories_from_iterations = iterations.first.stories
+
+...
+
+api.reset!
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/pivotaltracker/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 a new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/pivotaltracker.rb

@@ -0,0 +1,24 @@
+require 'pivotaltracker/version'
+require 'pivotaltracker/api'
+require 'pivotaltracker/iteration'
+require 'pivotaltracker/project'
+require 'pivotaltracker/story'
+require 'pivotaltracker/resource'
+require 'faraday'
+
+module PivotalTracker
+  NoProjectError = Class.new(StandardError) do
+    def initialize(project_id)
+      @project_id = project_id
+    end
+
+    def inspect
+      "No project with id #{@project_id}"
+    end
+  end
+end
+
+begin
+  require 'pry'
+rescue LoadError
+end

data/lib/pivotaltracker/api.rb

@@ -0,0 +1,23 @@
+require 'pivotaltracker/api/configuration'
+require 'pivotaltracker/api/client'
+require 'pivotaltracker/api/host'
+
+module PivotalTracker
+  class API
+    def self.configure
+      yield(configuration)
+    end
+
+    def self.reset!
+      @configuration = Configuration.new
+    end
+
+    def self.configuration
+      @configuration ||= Configuration.new
+    end
+
+    def self.build_client
+      @configuration.client.new(@configuration.token)
+    end
+  end
+end

data/lib/pivotaltracker/api/client.rb

@@ -0,0 +1,24 @@
+module PivotalTracker
+  class API
+    class Client
+      def initialize(token, adapter=::Faraday)
+        @adapter = adapter
+        @token = token
+      end
+
+      def get(endpoint, id, options={})
+        endpoint_url = build_url(endpoint, id, options)
+        connection = @adapter.new(url: ::PivotalTracker::API::HOST)
+        response = connection.get(endpoint_url) { |req| req.headers['X-TrackerToken'] = @token }
+        response
+      end
+
+      private
+
+      def build_url(endpoint, id, options={})
+        parsed_endpoint = endpoint.gsub(/:project_id/, id.to_s)
+        "services/v5/#{parsed_endpoint}"
+      end
+    end
+  end
+end

data/lib/pivotaltracker/api/configuration.rb

@@ -0,0 +1,11 @@
+module PivotalTracker
+  class API
+    class Configuration
+      attr_accessor :token, :client
+
+      def initialize(client=PivotalTracker::API::Client)
+        @client = client
+      end
+    end
+  end
+end

data/lib/pivotaltracker/api/host.rb

@@ -0,0 +1,5 @@
+module PivotalTracker
+  class API
+    HOST="https://www.pivotaltracker.com/"
+  end
+end

data/lib/pivotaltracker/iteration.rb

@@ -0,0 +1,5 @@
+module PivotalTracker
+  class Iteration
+    ITERATIONS_ENDPOINT= "/projects/:project_id/iterations"
+  end
+end

data/lib/pivotaltracker/project.rb

@@ -0,0 +1,14 @@
+require 'json'
+
+module PivotalTracker
+  class Project
+    PROJECT_ENDPOINT = "projects/:project_id"
+
+    def self.find(id)
+      client = PivotalTracker::API.build_client
+      response = client.get(PROJECT_ENDPOINT, id)
+      raise NoProjectError.new(id) if response.status != 200
+      ::PivotalTracker::Resource::Project.new(::JSON.parse(response.body))
+    end
+  end
+end

data/lib/pivotaltracker/resource.rb

@@ -0,0 +1,9 @@
+require 'pivotaltracker/resource/iteration'
+require 'pivotaltracker/resource/project'
+require 'pivotaltracker/resource/story'
+
+module PivotalTracker
+  module Resource
+
+  end
+end

data/lib/pivotaltracker/resource/iteration.rb

@@ -0,0 +1,15 @@
+module PivotalTracker
+  module Resource
+    class Iteration
+      attr_reader :project_id
+
+      def initialize(data)
+        @project_id = data.fetch("project_id")
+      end
+
+      def project
+        ::PivotalTracker::Project.find(project_id)
+      end
+    end
+  end
+end

data/lib/pivotaltracker/resource/project.rb

@@ -0,0 +1,36 @@
+module PivotalTracker
+  module Resource
+    class Project
+      include Comparable
+
+      attr_reader :id
+
+      def initialize(data)
+        @id = data.fetch("id")
+      end
+
+      def stories
+        fetch(::PivotalTracker::Story::STORIES_ENDPOINT, ::PivotalTracker::Resource::Story)
+      end
+
+      def iterations
+        fetch(::PivotalTracker::Iteration::ITERATIONS_ENDPOINT, ::PivotalTracker::Resource::Iteration)
+      end
+
+      def <=>(another_project)
+        id <=> another_project.id
+      end
+
+      private
+
+      def fetch(endpoint, resource_klass)
+        client = PivotalTracker::API.build_client
+        response = client.get(endpoint, id)
+        raise NoProjectError.new(id) if response.status != 200
+        ::JSON.parse(response.body).map do |data|
+          resource_klass.new(data)
+        end
+      end
+    end
+  end
+end

data/lib/pivotaltracker/resource/story.rb

@@ -0,0 +1,9 @@
+module PivotalTracker
+  module Resource
+    class Story
+      def initialize(data)
+        @id = data.fetch("id")
+      end
+    end
+  end
+end

data/lib/pivotaltracker/story.rb

@@ -0,0 +1,5 @@
+module PivotalTracker
+  class Story
+    STORIES_ENDPOINT = "projects/:project_id/stories"
+  end
+end

data/lib/pivotaltracker/version.rb

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

data/pivotaltracker.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pivotaltracker/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "pivotaltracker"
+  spec.version       = PivotalTracker::VERSION
+  spec.authors       = ["Alvaro F. Lara"]
+  spec.email         = ["alvaro.lara@alliants.com"]
+  spec.summary       = %q{Pivotal Tracker API v.5 client.}
+  spec.description   = %q{Pivotal Tracker API v.5 client.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "faraday", "~> 0.9.1"
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "byebug"
+  spec.add_development_dependency "codeclimate-test-reporter"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "vcr"
+  spec.add_development_dependency "webmock"
+end

data/spec/fixtures/vcr_cassettes/projects_project_id367813.yml

@@ -0,0 +1,64 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://www.pivotaltracker.com/services/v5/projects/367813
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v0.9.1
+      X-Trackertoken:
+      - ''
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Type:
+      - application/json; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Status:
+      - 200 OK
+      X-Tracker-Project-Version:
+      - '79039'
+      X-Ua-Compatible:
+      - IE=Edge,chrome=1
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+      X-Request-Id:
+      - 72e78b7a62b1802202a853340109cd68
+      X-Runtime:
+      - '0.052844'
+      Date:
+      - Wed, 25 Feb 2015 08:51:50 GMT
+      X-Rack-Cache:
+      - miss
+      X-Powered-By:
+      - Phusion Passenger 4.0.41
+      Server:
+      - nginx/1.6.0 + Phusion Passenger 4.0.41
+      Access-Control-Allow-Origin:
+      - "*"
+      Access-Control-Allow-Credentials:
+      - 'false'
+      Access-Control-Allow-Methods:
+      - GET, POST, PUT, DELETE, OPTIONS
+      Access-Control-Allow-Headers:
+      - X-TrackerToken,DNT,X-Mx-ReqToken,Keep-Alive,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type,X-Tracker-Warn-Unless-Project-Version-Is
+      X-Tracker-Client-Pinger-Interval:
+      - '8'
+    body:
+      encoding: ASCII-8BIT
+      string: '{"id":367813,"kind":"project","name":"Departments and policy (Dev)","version":79039,"iteration_length":2,"week_start_day":"Wednesday","point_scale":"0,1,2,3,5,8","point_scale_is_custom":false,"bugs_and_chores_are_estimatable":false,"automatic_planning":true,"enable_tasks":true,"time_zone":{"kind":"time_zone","olson_name":"Europe/London","offset":"+00:00"},"velocity_averaged_over":1,"number_of_done_iterations_to_show":12,"has_google_domain":false,"description":"The
+        \"departments and policy\" section of GOV.UK, including publishing tools for
+        government","enable_incoming_emails":true,"initial_velocity":25,"public":true,"atom_enabled":true,"start_date":"2011-09-14","start_time":"2011-09-13T23:00:00Z","created_at":"2011-09-11T19:50:57Z","updated_at":"2015-01-13T00:06:18Z","account_id":309645,"current_iteration_number":91,"enable_following":true}'
+    http_version: 
+  recorded_at: Wed, 25 Feb 2015 08:51:50 GMT
+recorded_with: VCR 2.9.3