pivotal-tracker-api 0.2.3 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ab585f160402f79d123587706e8c51fb779657aa
-  data.tar.gz: 1181ea8f46993d016907a5ed13bebf7432720d79
+  metadata.gz: cbfb334bb577e14833146540ec08e68f8dc26cca
+  data.tar.gz: dc59ed6076a4899c0b09458865c99aee9982d381
 SHA512:
-  metadata.gz: 497c21fe94dbdc3a2bc0700c027e75801056d41991adb6b132341c6b771ede50f5bdec4ec1270bf50673fb70a7b1c1e25219f7a795f98b93803abc613f9cae21
-  data.tar.gz: 611c2875df73319dc0b02590b6a33660bbe6dbd5543913751aa76c814adaf85b140ab1834d1331d5fe3e539db1af82b37093b556ae31b1e3ffbdccd33f3b4c7c
+  metadata.gz: 4b689d03586d7eed80ffb25444b47192adb4a5371c65b79710971805331f178d10bb092207f3800ecacf93b1fc006ae9ce67034636f2941bb78c7282b826b672
+  data.tar.gz: 9f959cc0af6ce48c3acde9785a10ad268bad1b82c3ee1376cf428b0f91636152bc6f99d14e8ce2c22f951b117004b06d38a8e93397063a113988c02e306aac60

data/Gemfile

@@ -3,13 +3,19 @@ source 'http://rubygems.org'
 # Example:
 #   gem 'activesupport', '>= 2.3.5'
 gem 'rest-client', '~> 1.7'
+gem 'business_time', '~> 0.7.6'
 
 # Add dependencies to develop your gem here.
 # Include everything needed to run rake, tests, features, etc.
 group :development do
-  gem 'shoulda', '>= 0'
   gem 'rdoc', '~> 3.12'
   gem 'bundler', '~> 1.0'
-  gem 'jeweler', '~> 1.8.7'
+  gem 'jeweler', '~> 2.1'
+end
+
+group :test do
+  gem 'shoulda'
+  gem "mocha"
+  gem 'test-unit'
   gem 'simplecov'
 end

data/Gemfile.lock

@@ -1,83 +1,101 @@
 GEM
   remote: http://rubygems.org/
   specs:
-    activesupport (4.0.0)
-      i18n (~> 0.6, >= 0.6.4)
-      minitest (~> 4.2)
-      multi_json (~> 1.3)
-      thread_safe (~> 0.1)
-      tzinfo (~> 0.3.37)
-    addressable (2.3.5)
-    atomic (1.1.14)
+    activesupport (5.0.0.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    addressable (2.4.0)
     builder (3.2.2)
-    faraday (0.8.8)
-      multipart-post (~> 1.2.0)
-    git (1.2.6)
-    github_api (0.10.1)
-      addressable
-      faraday (~> 0.8.1)
-      hashie (>= 1.2)
-      multi_json (~> 1.4)
-      nokogiri (~> 1.5.2)
-      oauth2
-    hashie (2.0.5)
-    highline (1.6.20)
-    httpauth (0.2.0)
-    i18n (0.6.5)
-    jeweler (1.8.8)
+    business_time (0.7.6)
+      activesupport (>= 3.1.0)
+      tzinfo
+    concurrent-ruby (1.0.2)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    faraday (0.9.2)
+      multipart-post (>= 1.2, < 3)
+    git (1.3.0)
+    github_api (0.14.5)
+      addressable (~> 2.4.0)
+      descendants_tracker (~> 0.0.4)
+      faraday (~> 0.8, < 0.10)
+      hashie (>= 3.4)
+      oauth2 (~> 1.0)
+    hashie (3.4.4)
+    highline (1.7.8)
+    i18n (0.7.0)
+    jeweler (2.1.1)
       builder
-      bundler (~> 1.0)
+      bundler (>= 1.0)
       git (>= 1.2.5)
-      github_api (= 0.10.1)
+      github_api
       highline (>= 1.6.15)
-      nokogiri (= 1.5.10)
+      nokogiri (>= 1.5.10)
       rake
       rdoc
-    json (1.8.1)
-    jwt (0.1.8)
-      multi_json (>= 1.5)
+      semver
+    json (1.8.3)
+    jwt (1.5.4)
+    metaclass (0.0.4)
     mime-types (2.4.3)
-    minitest (4.7.5)
-    multi_json (1.8.2)
+    mini_portile2 (2.1.0)
+    minitest (5.9.0)
+    mocha (1.1.0)
+      metaclass (~> 0.0.1)
+    multi_json (1.12.1)
     multi_xml (0.5.5)
-    multipart-post (1.2.0)
+    multipart-post (2.0.0)
     netrc (0.8.0)
-    nokogiri (1.5.10)
-    oauth2 (0.9.2)
-      faraday (~> 0.8)
-      httpauth (~> 0.2)
-      jwt (~> 0.1.4)
-      multi_json (~> 1.0)
+    nokogiri (1.6.8)
+      mini_portile2 (~> 2.1.0)
+      pkg-config (~> 1.1.7)
+    oauth2 (1.2.0)
+      faraday (>= 0.8, < 0.10)
+      jwt (~> 1.0)
+      multi_json (~> 1.3)
       multi_xml (~> 0.5)
-      rack (~> 1.2)
-    rack (1.5.2)
-    rake (10.1.0)
+      rack (>= 1.2, < 3)
+    pkg-config (1.1.7)
+    power_assert (0.3.0)
+    rack (2.0.1)
+    rake (11.2.2)
     rdoc (3.12.2)
       json (~> 1.4)
     rest-client (1.7.2)
       mime-types (>= 1.16, < 3.0)
       netrc (~> 0.7)
+    semver (1.0.1)
     shoulda (3.5.0)
       shoulda-context (~> 1.0, >= 1.0.1)
       shoulda-matchers (>= 1.4.1, < 3.0)
-    shoulda-context (1.1.5)
-    shoulda-matchers (2.4.0)
+    shoulda-context (1.2.1)
+    shoulda-matchers (2.8.0)
       activesupport (>= 3.0.0)
     simplecov (0.7.1)
       multi_json (~> 1.0)
       simplecov-html (~> 0.7.1)
     simplecov-html (0.7.1)
-    thread_safe (0.1.3)
-      atomic
-    tzinfo (0.3.38)
+    test-unit (3.2.1)
+      power_assert
+    thread_safe (0.3.5)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   bundler (~> 1.0)
-  jeweler (~> 1.8.7)
+  business_time (~> 0.7.6)
+  jeweler (~> 2.1)
+  mocha
   rdoc (~> 3.12)
   rest-client (~> 1.7)
   shoulda
   simplecov
+  test-unit
+
+BUNDLED WITH
+   1.12.5

data/README.md

@@ -10,7 +10,7 @@ A Pivotal Tracker API gem that can be used to interface with the Pivotal Tracker
 def set_token
   # This will set the @token in the Client class. Class caching must be enabled for the token to persist.
   # config.cache_classes = true
-  PivotalService.set_token(your_token_here)
+  PivotalAPI::Service.set_token(your_token_here)
 end
 ```
 
@@ -21,7 +21,7 @@ def get_user_token
   pass = params[:pass]
   # This will set the @token in the Client class. Class caching must be enabled for the token to persist.
   # config.cache_classes = true
-  token = Scorer::Client.token(email, pass)
+  token = PivotalAPI::Client.token(email, pass)
   # do something with the token
 end
 ```
@@ -29,14 +29,14 @@ end
 ```ruby
 # Get all of the users Projects
 def projects
-  @projects = PivotalService.all_projects(Scorer::Project.fields)
+  @projects = PivotalAPI::Service.all_projects(PivotalAPI::Project.fields)
 end
 ```
 
 ```ruby
 # Get only 1 of the users Projects
 def project
-  @project = PivotalService.one_project(params[:project_id], Scorer::Project.fields)
+  @project = PivotalAPI::Service.one_project(params[:project_id], PivotalAPI::Project.fields)
 end
 ```
 
@@ -45,7 +45,7 @@ end
 def stories_by_label
   project_label   = params[:project_label]
   @project_label  = CGI.escape(project_label) if project_label
-  @stories = PivotalService.all_stories(@project_label, @project, Scorer::Story.fields) if @project_label
+  @stories = PivotalAPI::Service.all_stories(@project_label, @project, PivotalAPI::Story.fields) if @project_label
 end
 ```
 
@@ -53,12 +53,12 @@ end
 # Get an Iteration and it's Stories
 def get_iteration
   @project_id = params[:project_id]
-  @iteration  = PivotalService.iterations(@project_id, 'current')
+  @iteration  = PivotalAPI::Service.iterations(@project_id, 'current')
   @stories    = @iteration.stories
 end
 ```
 
-For additional infomation on how to interface with this gem and use it to communicate with the Pivotal Tracker API v5 see the [PivotalService](https://github.com/atljeremy/pivotal-tracker-api/blob/master/lib/pivotal-tracker-api/pivotal_service.rb) class.
+For additional infomation on how to interface with this gem and use it to communicate with the Pivotal Tracker API v5 see the [PivotalAPI::Service](https://github.com/atljeremy/pivotal-tracker-api/blob/master/lib/pivotal-tracker-api/pivotal_service.rb) class.
 
 ### Contributing to pivotal-tracker-api
  

data/VERSION

@@ -1 +1 @@
-0.2.3
+1.0.0

data/lib/pivotal-tracker-api.rb

@@ -1,13 +1,21 @@
 require 'rest_client'
+require 'business_time'
 
+require File.join(File.dirname(__FILE__), 'pivotal-tracker-api', 'string_extensions')
+require File.join(File.dirname(__FILE__), 'pivotal-tracker-api', 'core_ext', 'string')
 require File.join(File.dirname(__FILE__), 'pivotal-tracker-api', 'base')
 require File.join(File.dirname(__FILE__), 'pivotal-tracker-api', 'client')
+require File.join(File.dirname(__FILE__), 'pivotal-tracker-api', 'cycle_time_details')
+require File.join(File.dirname(__FILE__), 'pivotal-tracker-api', 'label')
+require File.join(File.dirname(__FILE__), 'pivotal-tracker-api', 'analytics')
+require File.join(File.dirname(__FILE__), 'pivotal-tracker-api', 'story_transition')
 require File.join(File.dirname(__FILE__), 'pivotal-tracker-api', 'project')
-require File.join(File.dirname(__FILE__), 'pivotal-tracker-api', 'attachment')
+require File.join(File.dirname(__FILE__), 'pivotal-tracker-api', 'file_attachment')
 require File.join(File.dirname(__FILE__), 'pivotal-tracker-api', 'story')
 require File.join(File.dirname(__FILE__), 'pivotal-tracker-api', 'task')
 require File.join(File.dirname(__FILE__), 'pivotal-tracker-api', 'activity')
 require File.join(File.dirname(__FILE__), 'pivotal-tracker-api', 'iteration')
 require File.join(File.dirname(__FILE__), 'pivotal-tracker-api', 'comment')
 require File.join(File.dirname(__FILE__), 'pivotal-tracker-api', 'person')
-require File.join(File.dirname(__FILE__), 'pivotal-tracker-api', 'pivotal_service')
+require File.join(File.dirname(__FILE__), 'pivotal-tracker-api', 'me')
+require File.join(File.dirname(__FILE__), 'pivotal-tracker-api', 'service')

data/lib/pivotal-tracker-api/activity.rb

@@ -1,31 +1,65 @@
-module Scorer
+# PROPERTIES
+# guid string
+#  —  Project id and version of the activity. This field is read only. This field is always returned.
+#
+# project_version int
+#  —  The version of the activity. This field is read only. This field is always returned.
+#
+# message string
+#  —  Description of the activity. This field is read only.
+#
+# highlight string
+#  —  Boldface portion of the message. This field is read only.
+#
+# changes List[object]
+#  —  The set of changes. This field is read only.
+#
+# primary_resources List[object]
+#  —  The primary resource(s) affected by this command. This field is read only.
+#
+# project_id int
+#  —  id of the project. This field is read only. By default this will be included in responses as a nested structure, using the key project.
+#
+# performed_by_id int
+#  —  id of the person who performed this change. This field is read only. By default this will be included in responses as a nested structure, using the key performed_by.
+#
+# occurred_at datetime
+#  —  Time of the activity. This field is read only.
+#
+# kind string
+#  —  Thevalue of 'kind' will reflect the specific type of activity that an activity resource represents. The value will be a string that ends in '_activity' and which starts with a name based on the change which occurred. This field is read only.
+ 
+module PivotalAPI
   class Activity < Base
 
-    attr_accessor :project_id, :occurred_at, :highlight, :primary_resources, :changes, :guid, :kind, :performed_by_id,
+    attr_accessor :project_id, :occurred_at, :highlight, :primary_resources, 
+                  :changes, :guid, :kind, :performed_by_id,
                   :performed_by, :message, :project_version
 
-    def self.parse_json_activity(json_activity, project_id)
+    def self.from_json(json)
+      parse_json_activity(json) if json.is_a?(Array)
+    end
+
+    protected
+    
+    def self.parse_json_activity(json_activity)
+      parsed_activity = []
       json_activity.each do |activity|
-        new({
-          project_id: project_id,
-          occurred_at: activity[:stories],
-          highlight: activity[:number],
-          primary_resources: activity[:team_strength],
-          changes: activity[:finish],
-          guid: activity[:kind],
-          kind: activity[:start],
+        parsed_activity << new({
+          project_id: activity[:project_id].to_i,
+          occurred_at: DateTime.parse(activity[:occurred_at].to_s),
+          highlight: activity[:highlight],
+          primary_resources: activity[:primary_resources],
+          changes: activity[:changes],
+          guid: activity[:guid],
+          kind: activity[:kind],
           performed_by_id: activity[:performed_by_id],
-          performed_by: parse_person(activity[:performed_by]),
+          performed_by: Person.from_json(activity[:performed_by]),
           message: activity[:message],
           project_version: activity[:project_version]
         })
       end
-    end
-
-    protected
-
-    def self.parse_person(json_person)
-      Scorer::Person.parse_json_person(json_person)
+      parsed_activity
     end
 
   end

data/lib/pivotal-tracker-api/analytics.rb

@@ -0,0 +1,23 @@
+# PROPERTIES
+# stories_accepted int
+#  —  Number of stories accepted during this iteration. This field is read only.
+#
+# bugs_created int
+#  —  Number of new bugs created. This field is read only.
+#
+# cycle_time int
+#  —  Median cycle time in milliseconds for contained stories. This field is read only.
+#
+# rejection_rate float
+#  —  Percentage of accepted bugs and features in the iteration that have ever been rejected. This field is read only.
+#
+# kind string
+#  —  The type of this object: analytics. This field is read only.
+
+module PivotalAPI
+  class Analytics < Base
+
+    attr_accessor :stories_accepted, :bugs_created, :cycle_time, :rejection_rate, :kind 
+
+  end
+end

data/lib/pivotal-tracker-api/base.rb

@@ -1,9 +1,21 @@
-module Scorer
+module PivotalAPI
   class Base
 
     def initialize(attributes={})
       update_attributes(attributes)
     end
+    
+    def self.from_json(json)
+      object = nil
+      if json.is_a?(Array)
+        vals = []
+        json.each { |val| vals << new(val) }
+        object = vals
+      else
+        object = new(json)
+      end
+      object
+    end
 
     def to_json
       hash = {}
@@ -21,7 +33,7 @@ module Scorer
       attrs.each do |key, value|
         # self.send("#{key}=", value.is_a?(Array) ? value.join(',') : value )
         self.send("#{key}=", value)
-      end
+      end if attrs
     end
 
   end

data/lib/pivotal-tracker-api/client.rb

@@ -1,12 +1,11 @@
-module Scorer
+module PivotalAPI
   class Client
 
     class NoToken < StandardError; end
 
     class << self
 
-      attr_writer :token, :ssl_enabled
-      attr_reader :api_host, :api_projects_path
+      attr_writer :token, :username, :password
 
       def get(path)
         begin
@@ -17,6 +16,20 @@ module Scorer
           set_response_headers(connection["#{api_version}#{path}"].get)
         end
       end
+      
+      def ssl_get(path)
+        raise ArgumentError.new("missing required fields :username and :password. " \
+                                "Set these using PivotalAPI::Client.username = USERNAME " \
+                                "and PivotalAPI::Client.password = PASSWORD.") unless @username && @password
+        begin
+          puts "ssl_connection: #{ssl_connection}"
+          set_response_headers(ssl_connection["#{api_version}#{path}"].get)
+        rescue
+          puts "Encountered Error in ssl_get: #{$!}"
+          clear_connections
+          set_response_headers(ssl_connection["#{api_version}#{path}"].get)
+        end
+      end
 
       def get_with_caching(path)
         begin
@@ -37,32 +50,29 @@ module Scorer
         @connections ||= {}
         cached_connection? ? cached_connection : new_connection
       end
+      
+      def ssl_connection
+        raise NoToken if @username.to_s.empty?
+        @connections ||= {}
+        cached_ssl_connection? ? cached_ssl_connection : new_ssl_connection
+      end
 
       def clear_connections
         @connections = nil
       end
 
-      def ssl_enabled
-        @ssl_enabled || true
-      end
-
-      def token(username, password)
-        response = RestClient.get("#{api_ssl_host(username, password)}#{api_version}/me")
-        json = JSON.parse(response, {:symbolize_names => true})
-        @token = json[:api_token]
-      end
-
-      def api_ssl_host(user=nil, password=nil)
-        user_password = (user && password) ? "#{user}:#{CGI.escape(password)}@" : ''
-        "https://#{user_password}www.pivotaltracker.com"
+      def api_ssl_host
+        "https://#{@username}:#{CGI.escape(@password)}@www.pivotaltracker.com"
       end
 
       def api_host
-        @api_host ||= 'http://www.pivotaltracker.com'
+        @api_host ||= 'https://www.pivotaltracker.com'
       end
-
-      def api_projects_path
-        @api_projects_path ||= "#{ssl_enabled ? api_ssl_host : api_host}#{api_version}/projects"
+      
+      def token=(val)
+        @username = nil
+        @password = nil
+        @token = val
       end
 
       protected
@@ -87,7 +97,19 @@ module Scorer
         end
 
         def new_connection
-          @connections[@token] = RestClient::Resource.new("#{ssl_enabled ? api_ssl_host : api_host}", :headers => {'X-TrackerToken' => @token, 'Content-Type' => 'application/json'})
+          @connections[@token] = RestClient::Resource.new(api_host, :headers => {'X-TrackerToken' => @token, 'Content-Type' => 'application/json'})
+        end
+        
+        def cached_ssl_connection?
+          !@connections[@username].nil?
+        end
+
+        def cached_ssl_connection
+          @connections[@username]
+        end
+        
+        def new_ssl_connection
+          @connections[@username] = RestClient::Resource.new(api_ssl_host, :headers => {'Content-Type' => 'application/json'})
         end
 
     end