tracker_api 0.2.5 → 0.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f4d013c6228760ae953b8a63e8eb9bfb46491e82
-  data.tar.gz: c103f57b86db7418f2d2390ec1dc81ffbfcdacf6
+  metadata.gz: b9b4b422159e2a7ed286a626f35cc996a8dcb218
+  data.tar.gz: fa36b559c306a27b509d2314d52b9a795c6d69f3
 SHA512:
-  metadata.gz: 59f28333799be92a3e38edb8bdd5bd4f1cd113c781a21f653ab34673eadd3f1a325f55b09d6a3d9286a483b826ef2d8e1c833cae9e3b1adfb1dd7ba0a9a42565
-  data.tar.gz: 31d1d0096e0b79af497df676d0ae19d24fac653d7b529f8bd8a5505b8e02f49cdf503bb7eaa214709ab4b530f6c2eef3ca02dcd655d1ecac7071bb2e57d82382
+  metadata.gz: 620622ef5cc89906fb1d025d83c2507f9ae92f965501f8acf756fe8780ba30e37fa589c2c777e9cbfcd8c143419915537ec7c64ea195a9a190e3155916747cce
+  data.tar.gz: e8af9bb5b17c3863ebe7e5f1e2e6c5656a238ad6702fbd5c8c96a07a92390ed493ccf862d209be87f89f72a72c500dedaeeee3c752651d346276649377838862

data/README.md

@@ -44,6 +44,7 @@ project.stories                                                           # Get
 project.stories(with_state: :unscheduled, limit: 10)                      # Get 10 unscheduled stories for a project
 project.stories(filter: 'requester:OWK label:"jedi stuff"')               # Get all stories that match the given filters
 project.story(847762630)                                                  # Find a story with the given ID
+project.create_story(name: 'Destroy death star')                          # Create a story with the name 'Destroy death star'
 
 epics = project.epics                                                     # Get all epics for a project
 epic  = epics.first

data/lib/tracker_api/client.rb

@@ -54,6 +54,15 @@ module TrackerApi
       request(:get, parse_query_and_convenience_headers(path, options))
     end
 
+    # Make a HTTP POST request
+    #
+    # @param path [String] The path, relative to api endpoint
+    # @param options [Hash] Query and header params for request
+    # @return [Faraday::Response]
+    def post(path, options = {})
+      request(:post, parse_query_and_convenience_headers(path, options))
+    end
+
     # Make one or more HTTP GET requests, optionally fetching
     # the next page of results from information passed back in headers
     # based on value in {#auto_paginate}.
@@ -67,11 +76,12 @@ module TrackerApi
     # @return [Array]
     def paginate(path, options = {}, &block)
       opts           = parse_query_and_convenience_headers path, options.dup
+      auto_paginate  = opts[:params].delete(:auto_paginate) { |k| @auto_paginate }
       @last_response = request :get, opts
       data           = @last_response.body
       raise TrackerApi::Errors::UnexpectedData, 'Array expected' unless data.is_a? Array
 
-      if @auto_paginate
+      if auto_paginate
         pager = Pagination.new @last_response.headers
 
         while pager.more?

data/lib/tracker_api/endpoints/epic.rb

@@ -10,7 +10,7 @@ module TrackerApi
       def get(project_id, id)
         data = client.get("/projects/#{project_id}/epics/#{id}").body
 
-        Resources::Epic.new({ client: client }.merge(data))
+        Resources::Epic.new({ client: client, project_id: project_id }.merge(data))
       end
     end
   end

data/lib/tracker_api/endpoints/epics.rb

@@ -11,7 +11,9 @@ module TrackerApi
         data = client.paginate("/projects/#{project_id}/epics", params: params)
         raise TrackerApi::Errors::UnexpectedData, 'Array of epics expected' unless data.is_a? Array
 
-        data.map { |epic| Resources::Epic.new({ client: client }.merge(epic)) }
+        data.map do |epic|
+          Resources::Epic.new({ client: client, project_id: project_id }.merge(epic))
+        end
       end
     end
   end

data/lib/tracker_api/endpoints/iterations.rb

@@ -11,7 +11,9 @@ module TrackerApi
         data = client.paginate("/projects/#{project_id}/iterations", params: params)
         raise TrackerApi::Errors::UnexpectedData, 'Array of iterations expected' unless data.is_a? Array
 
-        data.map { |iteration| Resources::Iteration.new({ client: client }.merge(iteration)) }
+        data.map do |iteration|
+          Resources::Iteration.new({ client: client, project_id: project_id }.merge(iteration))
+        end
       end
     end
   end

data/lib/tracker_api/endpoints/memberships.rb

@@ -11,7 +11,9 @@ module TrackerApi
         data = client.paginate("/projects/#{project_id}/memberships", params: params)
         raise TrackerApi::Errors::UnexpectedData, 'Array of memberships expected' unless data.is_a? Array
 
-        data.map { |membership| Resources::ProjectMembership.new({ client: client }.merge(membership)) }
+        data.map do |membership|
+          Resources::ProjectMembership.new({ client: client, project_id: project_id }.merge(membership))
+        end
       end
     end
   end

data/lib/tracker_api/endpoints/stories.rb

@@ -11,7 +11,9 @@ module TrackerApi
         data = client.paginate("/projects/#{project_id}/stories", params: params)
         raise TrackerApi::Errors::UnexpectedData, 'Array of stories expected' unless data.is_a? Array
 
-        data.map { |story| Resources::Story.new({ client: client }.merge(story)) }
+        data.map do |story|
+          Resources::Story.new({ client: client, project_id: project_id }.merge(story))
+        end
       end
     end
   end

data/lib/tracker_api/endpoints/story.rb

@@ -10,7 +10,7 @@ module TrackerApi
       def get(project_id, id)
         data = client.get("/projects/#{project_id}/stories/#{id}").body
 
-        Resources::Story.new({ client: client }.merge(data))
+        Resources::Story.new({ client: client, project_id: project_id }.merge(data))
       end
 
       def get_story(story_id)
@@ -18,6 +18,12 @@ module TrackerApi
 
         Resources::Story.new({ client: client }.merge(data))
       end
+
+      def create(project_id, params={})
+        data = client.post("/projects/#{project_id}/stories", params: params).body
+
+        Resources::Story.new({ client: client }.merge(data))
+      end
     end
   end
 end

data/lib/tracker_api/endpoints/tasks.rb

@@ -11,7 +11,9 @@ module TrackerApi
         data = client.paginate("/projects/#{project_id}/stories/#{story_id}/tasks", params: params)
         raise TrackerApi::Errors::UnexpectedData, 'Array of tasks expected' unless data.is_a? Array
 
-        data.map { |task| Resources::Task.new({ client: client }.merge(task)) }
+        data.map do |task|
+          Resources::Task.new({ client: client, project_id: project_id }.merge(task))
+        end
       end
     end
   end

data/lib/tracker_api/resources/project.rb

@@ -90,6 +90,12 @@ module TrackerApi
       def story(story_id)
         Endpoints::Story.new(client).get(id, story_id)
       end
+
+      # @param [Hash] hash of attributes to create the story
+      # @return [Story] Story with given id
+      def create_story(params)
+        Endpoints::Story.new(client).create(id, params)
+      end
     end
   end
 end

data/lib/tracker_api/version.rb

@@ -1,3 +1,3 @@
 module TrackerApi
-  VERSION = '0.2.5'
+  VERSION = '0.2.6'
 end

data/test/client_test.rb

@@ -101,6 +101,17 @@ describe TrackerApi::Client do
       end
     end
 
+    it 'allows auto pagination to be turned off when just a subset of a list is desired' do
+      VCR.use_cassette('client: get limited stories with no pagination', record: :new_episodes) do
+        project = client.project(project_id)
+
+        # force no pagination
+        stories = project.stories(limit: 7, auto_paginate: false)
+        stories.wont_be_empty
+        stories.length.must_equal 7
+      end
+    end
+
     it 'can handle negative offsets' do
       VCR.use_cassette('client: done iterations with pagination', record: :new_episodes) do
         project = client.project(project_id)

data/test/minitest_helper.rb

@@ -19,7 +19,7 @@ VCR.configure do |c|
   c.ignore_localhost         = true
   c.cassette_library_dir     = File.expand_path('../vcr/cassettes', __FILE__).to_s
   c.default_cassette_options = { serialize_with: :json }
-  c.hook_into :faraday
+  c.hook_into :excon
   c.allow_http_connections_when_no_cassette = false
 end
 

data/test/project_test.rb

@@ -77,5 +77,16 @@ describe TrackerApi::Resources::Project do
         story.current_state.must_equal 'unscheduled'
       end
     end
+
+    it 'can create story' do
+      VCR.use_cassette('create story') do
+        story = project.create_story(name: 'Test story')
+
+        story.must_be_instance_of TrackerApi::Resources::Story
+        story.id.wont_be_nil
+        story.id.must_be :>, 0
+        story.name.must_equal 'Test story'
+      end
+    end
   end
 end

data/test/story_test.rb

@@ -7,7 +7,7 @@ describe TrackerApi::Resources::Story do
   let(:project) { VCR.use_cassette('get project') { client.project(project_id) } }
 
   describe '.tasks' do
-    it "gets all tasks for this story" do
+    it 'gets all tasks for this story' do
       VCR.use_cassette('get tasks', record: :new_episodes) do
         tasks = project.story('66728004').tasks
 
@@ -16,5 +16,18 @@ describe TrackerApi::Resources::Story do
         task.must_be_instance_of TrackerApi::Resources::Task
       end
     end
+
+    it 'gets all tasks even when the project_id is excluded from the story fields' do
+      VCR.use_cassette('get tasks when stories filtered', record: :new_episodes) do
+        stories = project.stories(with_state: 'unstarted', fields: 'name,story_type')
+        stories.each do |story|
+          tasks = story.tasks
+          unless tasks.empty?
+            task = tasks.first
+            task.must_be_instance_of TrackerApi::Resources::Task
+          end
+        end
+      end
+    end
   end
 end

data/tracker_api.gemspec

@@ -23,6 +23,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'minitest'
   spec.add_development_dependency 'awesome_print'
   spec.add_development_dependency 'vcr'
+  spec.add_development_dependency 'excon'
   spec.add_development_dependency 'multi_json'
   # spec.add_development_dependency 'byebug'
   # spec.add_development_dependency 'pry-byebug'
@@ -30,7 +31,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'addressable'
   spec.add_dependency 'virtus'
-  spec.add_dependency 'faraday', '~> 0.8.0'
+  spec.add_dependency 'faraday', '~> 0.9.0'
   spec.add_dependency 'faraday_middleware'
   # spec.add_dependency 'excon'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tracker_api
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.2.6
 platform: ruby
 authors:
 - Forest Carlisle
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-10 00:00:00.000000000 Z
+date: 2014-11-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -80,6 +80,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: excon
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: multi_json
   requirement: !ruby/object:Gem::Requirement
@@ -128,14 +142,14 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.8.0
+        version: 0.9.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.8.0
+        version: 0.9.0
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
@@ -228,7 +242,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
 summary: API client for the Pivotal Tracker v5 API