sprintly-data-ruby 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 06e8b3045ff45dd6dee0cfd7d516ef749c9ef5b5
-  data.tar.gz: 904354afb6b74a903bbab5629f09b30f47ffd9ff
+  metadata.gz: 275dc8e614da2efd85a2fc0fbba5da3fe715d3c8
+  data.tar.gz: c5ada177d97a1467e0336d20aaca94c43a151345
 SHA512:
-  metadata.gz: f851594f9bd583f36b51f91272ce976ec1807885e7ba9a9da65f384b388b2433130d9a33d4c5c4ff35a0a8f619d0b84e4f90904f88623088a4c6b1a346d772c0
-  data.tar.gz: 35bb0061625ab88cd14c9a9d1dd548e04fcbd058f5600e15324a2896c32ecc5ce268b42d284baae28e8be517c6ed64ddbe1d7f1076139a086f86a50d712961d5
+  metadata.gz: 59f972a2435b090af6f438128b46f06243e9b7221dfe39bd4e19012d85715d8238c3d0a57724dc25ff21ca04af7c7aa1c46549e3886cb288ab2cec539a64329e
+  data.tar.gz: 1b764d1356ac24d17d1d1133a86d7d552e5376988017d9a6dd41dd05f1f786898efcd43ab914c54a6ec0175e7a526b75d47938865e59ed8532ad9777641ccb4c

data/.gitignore

@@ -1 +1,2 @@
-test/fixtures
+test/fixtures
+*.gem

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    sprintly-data-ruby (0.1.0)
+    sprintly-data-ruby (0.2.1)
       faraday
       json
 
@@ -34,10 +34,10 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.10)
+  bundler
   minitest
   pry
-  rake (~> 10.0)
+  rake
   sprintly-data-ruby!
   vcr
   webmock

data/README.md

@@ -1,8 +1,8 @@
 # Sprintly::Data::Ruby
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/sprintly/data/ruby`. To experiment with that code, run `bin/console` for an interactive prompt.
+[![wercker status](https://app.wercker.com/status/5e214b2e6c5704189acc37a7c049b8e7/m "wercker status")](https://app.wercker.com/project/bykey/5e214b2e6c5704189acc37a7c049b8e7)
 
-TODO: Delete this and the text above, and describe your gem
+The Sprintly Data Ruby gem easily fetches Products and Items for an authorized Sprintly user.
 
 ## Installation
 
@@ -22,7 +22,26 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Before using the gem, you must set environment variables for `SPRINTLY_EMAIL` and `SPRINTLY_API_KEY`. You can find your Sprintly API key from the User Account page in Sprintly.
+
+An example method call to receive all products for the authorized Sprintly user looks like this:
+
+```
+Sprintly::Product.all
+```
+
+The gem also contains an instance method to retrieve all stories that are of a certain status for any given product. The following will return all items in the backlog for the first Sprintly Product returned by the `.all` query.
+
+```
+Sprintly::Product.all.first.get_items_by_status("backlog")
+```
+
+
+You can also see all items for a given product by replacing the `product_id` below with a valid Sprintly Product ID.
+
+```
+Sprintly::Item.for_product(product_id)
+```
 
 ## Development
 
@@ -32,10 +51,12 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/sprintly-data-ruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/quickleft/sprintly-data-ruby.
 
 
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
 
+
+

data/lib/sprintly-data-ruby/item.rb

@@ -14,6 +14,12 @@ module Sprintly
       raw_items.map { |raw_item| new(raw_item) }
     end
 
+    def self.all_for_product(product_id)
+      response = Sprintly::Connection.get("products/#{product_id}/items.json?status=someday,backlog,in-progress,completed,accepted")
+      raw_items = JSON.parse(response.body)
+      raw_items.map { |raw_item| new(raw_item) }
+    end
+
     def initialize(raw_item)
       WHITELISTED_ATTRIBUTES.each do |attr|
         if raw_item.has_key?(attr)

data/lib/sprintly-data-ruby/version.rb

@@ -1,3 +1,3 @@
 module Sprintly
-  VERSION = "0.2.0"
-end
+  VERSION = "0.2.1"
+end

data/sprintly-data-ruby.gemspec

@@ -19,8 +19,8 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.10"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
   spec.add_development_dependency "minitest"
   spec.add_development_dependency "vcr"
   spec.add_development_dependency "webmock"

data/wercker.yml

@@ -0,0 +1,8 @@
+box: wercker/ruby
+ruby: 2.2.2
+build:
+    steps:
+        - bundle-install
+        - script:
+            name: test
+            code: bundle exec rake test

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: sprintly-data-ruby
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Quick Left
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-08-14 00:00:00.000000000 Z
+date: 2015-09-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -146,6 +146,7 @@ files:
 - lib/sprintly-data-ruby/version.rb
 - sprintly-data-ruby-0.1.0.gem
 - sprintly-data-ruby.gemspec
+- wercker.yml
 homepage: https://github.com/quickleft/sprintly-data-ruby
 licenses:
 - BSD
@@ -166,7 +167,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Sprintly API interface for Ruby applications