commons 0.0.1 → 0.0.2

data/README.md

@@ -1,34 +1,28 @@
-#Commons
-=======
-A Ruby wrapper for the Civic Commons MarketPlace API at [http://marketplace.civiccommons.org/api](http://marketplace.civiccommons.org/api)
+# Commons [![Build Status](https://secure.travis-ci.org/codeforamerica/commons.png?branch=master)][travis] [![Dependency Status](https://gemnasium.com/codeforamerica/commons.png?travis)][gemnasium]
+A Ruby Wrapper for the Civic Commons Marketplace API
 
-Does your project or organization use this gem?
-------------------------------------------
-Add it to the [apps](http://github.com/codeforamerica/commons/wiki/apps) wiki!
+[travis]: http://travis-ci.org/codeforamerica/commons
+[gemnasium]: https://gemnasium.com/codeforamerica/commons
 
-Installation
-------------
-    $ gem install commons
+## <a name="installation"></a>Installation
+    gem install commons
 
-Documentation
--------------
+## <a name="documentation"></a>Documentation
 [http://rdoc.info/gems/commons](http://rdoc.info/gems/commons)
 
-Continuous Integration
-----------------------
-[![Build Status](https://secure.travis-ci.org/codeforamerica/commons.png)](http://travis-ci.org/codeforamerica/commons)
 
-Usage Examples
---------------
+## <a name="examples"><a/>Usage Examples
     require 'commons'
 
-	@client = Commons::Client::New
-	a = @client.content("13813")
-  a.title # => "YouTown"
+    @client = Commons.new
+    a = @client.content("13813")
+    a.title # => "YouTown"
 
-Contributing
-------------
-In the spirit of [free software](http://www.fsf.org/licensing/essays/free-sw.html), **everyone** is encouraged to help improve this project.
+## <a name="contributing"></a>Contributing
+In the spirit of [free software][free-sw], **everyone** is encouraged to help
+improve this project.
+
+[free-sw]: http://www.fsf.org/licensing/essays/free-sw.html
 
 Here are some ways *you* can contribute:
 
@@ -37,36 +31,72 @@ Here are some ways *you* can contribute:
 * by suggesting new features
 * by writing or editing documentation
 * by writing specifications
-* by writing code (**no patch is too small**: fix typos, add comments, clean up inconsistent whitespace)
+* by writing code (**no patch is too small**: fix typos, add comments, clean up
+  inconsistent whitespace)
 * by refactoring code
-* by resolving [issues](http://github.com/codeforamerica/commons/issues)
+* by closing [issues][]
 * by reviewing patches
+* [financially][]
+
+[issues]: https://github.com/codeforamerica/commons/issues
+[financially]: https://secure.codeforamerica.org/page/contribute
+
+## <a name="issues"></a>Submitting an Issue
+We use the [GitHub issue tracker][issues] to track bugs and features. Before
+submitting a bug report or feature request, check to make sure it hasn't
+already been submitted. You can indicate support for an existing issue by
+voting it up. When submitting a bug report, please include a [Gist][] that
+includes a stack trace and any details that may be necessary to reproduce the
+bug, including your gem version, Ruby version, and operating system. Ideally, a
+bug report should include a pull request with failing specs.
+
+[gist]: https://gist.github.com/
 
-Submitting an Issue
--------------------
-We use the [GitHub issue tracker](http://github.com/codeforamerica/commons/issues) to track bugs and
-features. Before submitting a bug report or feature request, check to make sure it hasn't already
-been submitted. You can indicate support for an existing issuse by voting it up. When submitting a
-bug report, please include a [Gist](http://gist.github.com/) that includes a stack trace and any
-details that may be necessary to reproduce the bug, including your gem version, Ruby version, and
-operating system. Ideally, a bug report should include a pull request with failing specs.
-
-Submitting a Pull Request
--------------------------
+## <a name="pulls"></a>Submitting a Pull Request
 1. Fork the project.
 2. Create a topic branch.
 3. Implement your feature or bug fix.
-4. Add documentation for your feature or bug fix.
-5. Run <tt>bundle exec rake doc:yard</tt>. If your changes are not 100% documented, go back to step 4.
-6. Add specs for your feature or bug fix.
-7. Run <tt>bundle exec rake spec</tt>. If your changes are not 100% covered, go back to step 6.
-8. Commit and push your changes.
-9. Submit a pull request. Please do not include changes to the gemspec, version, or history file. (If you want to create your own version for some reason, please do so in a separate commit.)
-
-Copyright
----------
-Copyright (c) 2010 Code for America Laboratories
-See [LICENSE](https://github.com/cfalabs/commons/blob/master/LICENSE.md) for details.
-
-[![Code for America Tracker](http://stats.codeforamerica.org/codeforamerica/commons.png)](http://stats.codeforamerica.org/projects/commons)
+4. Add tests for your feature or bug fix.
+5. Run `bundle exec rake spec`. If your changes are not 100% covered, go back
+   to step 4.
+6. Commit and push your changes.
+7. Submit a pull request. Please do not include changes to the gemspec or
+   version file. (If you want to create your own version for some reason,
+   please do so in a separate commit.)
+
+## <a name="versions"></a>Supported Ruby Versions
+This library aims to support and is [tested against][travis] the following Ruby
+implementations:
+
+* Ruby 1.8.7
+* Ruby 1.9.2
+* Ruby 1.9.3
+
+If something doesn't work on one of these interpreters, it should be considered
+a bug.
+
+This library may inadvertently work (or seem to work) on other Ruby
+implementations, however support will only be provided for the versions listed
+above.
+
+If you would like this library to support another Ruby version, you may
+volunteer to be a maintainer. Being a maintainer entails making sure all tests
+run and pass on that implementation. When something breaks on your
+implementation, you will be personally responsible for providing patches in a
+timely fashion. If critical issues for a particular implementation exist at the
+time of a major release, support for that Ruby version may be dropped.
+
+
+## Credits
+Civic Commons Marketplace API - [API](http://marketplace.civiccommons.org/api)
+
+
+## <a name="copyright"></a>Copyright
+Copyright (c) 2012 Code for America. See [LICENSE][] for details.
+
+[license]: https://github.com/codeforamerica/commons/blob/master/LICENSE.md
+
+[![Code for America Tracker](http://stats.codeforamerica.org/codeforamerica/commons.png)][tracker]
+
+[tracker]: http://stats.codeforamerica.org/projects/commons
 

data/commons.gemspec

@@ -3,7 +3,7 @@ require File.expand_path('../lib/commons/version', __FILE__)
 
 Gem::Specification.new do |gem|
   gem.add_dependency 'faraday', '~> 0.7'
-  gem.add_dependency 'faraday_middleware', '~> 0.7'
+  gem.add_dependency 'faraday_middleware', '~> 0.8'
   gem.add_dependency 'hashie', '~> 1.2'
   gem.add_dependency 'multi_json', '~> 1.0'
   gem.add_dependency 'rash', '~> 0.3.2'

data/lib/commons/client/content.rb

@@ -6,7 +6,7 @@ module Commons
       # @param id [String] The id for the product number
       # @param options [Hash] A customizable set of options.
       # @return [Array<Hashie::Mash>]
-      # @see http://marketplace.civiccommons.org/api
+      # @see http://www.civiccommons.org/api
       # @example
       #   Comments.content("13351")
       def content(id,options={})

data/lib/commons/configuration.rb

@@ -16,7 +16,7 @@ module Commons
     DEFAULT_ADAPTER = :net_http
 
     # The endpoint that will be used to connect if none is set
-    DEFAULT_ENDPOINT = 'http://marketplace.civiccommons.org/api/v1'.freeze
+    DEFAULT_ENDPOINT = 'http://civiccommons.org/api/v1'.freeze
 
     # The response format appended to the path and sent in the 'Accept' header if none is set
     #

data/lib/commons/version.rb

@@ -1,3 +1,3 @@
 module Commons
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/helper.rb

@@ -21,5 +21,5 @@ def fixture(file)
 end
 
 def commons_url(url)
-  "http://marketplace.civiccommons.org/api/v1#{url}"
+  "http://civiccommons.org/api/v1#{url}"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: commons
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-31 00:00:00.000000000 Z
+date: 2012-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
-  requirement: &70211068357580 !ruby/object:Gem::Requirement
+  requirement: &70246211989300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,21 +21,21 @@ dependencies:
         version: '0.7'
   type: :runtime
   prerelease: false
-  version_requirements: *70211068357580
+  version_requirements: *70246211989300
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
-  requirement: &70211068356580 !ruby/object:Gem::Requirement
+  requirement: &70246211987820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '0.8'
   type: :runtime
   prerelease: false
-  version_requirements: *70211068356580
+  version_requirements: *70246211987820
 - !ruby/object:Gem::Dependency
   name: hashie
-  requirement: &70211068351920 !ruby/object:Gem::Requirement
+  requirement: &70246211986760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: '1.2'
   type: :runtime
   prerelease: false
-  version_requirements: *70211068351920
+  version_requirements: *70246211986760
 - !ruby/object:Gem::Dependency
   name: multi_json
-  requirement: &70211068350480 !ruby/object:Gem::Requirement
+  requirement: &70246211985580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: '1.0'
   type: :runtime
   prerelease: false
-  version_requirements: *70211068350480
+  version_requirements: *70246211985580
 - !ruby/object:Gem::Dependency
   name: rash
-  requirement: &70211068349100 !ruby/object:Gem::Requirement
+  requirement: &70246211984860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +65,10 @@ dependencies:
         version: 0.3.2
   type: :runtime
   prerelease: false
-  version_requirements: *70211068349100
+  version_requirements: *70246211984860
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70211068348560 !ruby/object:Gem::Requirement
+  requirement: &70246211983740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70211068348560
+  version_requirements: *70246211983740
 - !ruby/object:Gem::Dependency
   name: rdiscount
-  requirement: &70211068348100 !ruby/object:Gem::Requirement
+  requirement: &70246212897400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +87,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70211068348100
+  version_requirements: *70246212897400
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70211068347520 !ruby/object:Gem::Requirement
+  requirement: &70246212896980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,10 +98,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70211068347520
+  version_requirements: *70246212896980
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &70211068346780 !ruby/object:Gem::Requirement
+  requirement: &70246212896560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -109,10 +109,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70211068346780
+  version_requirements: *70246212896560
 - !ruby/object:Gem::Dependency
   name: webmock
-  requirement: &70211068346360 !ruby/object:Gem::Requirement
+  requirement: &70246212896140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -120,10 +120,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70211068346360
+  version_requirements: *70246212896140
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &70211068345920 !ruby/object:Gem::Requirement
+  requirement: &70246212895720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -131,7 +131,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70211068345920
+  version_requirements: *70246212895720
 description: Ruby Wrapper for the Civic Commons MarketPlace API - http://marketplace.civiccommons.org/api
 email: ryan@codeforamerica.org
 executables: []