commons 0.0.1

data/.gitignore

@@ -0,0 +1,40 @@
+*.gem
+*.rbc
+*.sw[a-p]
+*.tmproj
+*.tmproject
+*.un~
+*~
+.DS_Store
+.Spotlight-V100
+.Trashes
+._*
+.bundle
+.config
+.directory
+.elc
+.emacs.desktop
+.emacs.desktop.lock
+.redcar
+.yardoc
+Desktop.ini
+Gemfile.lock
+Icon?
+InstalledFiles
+Session.vim
+Thumbs.db
+\#*\#
+_yardoc
+auto-save-list
+coverage
+doc
+lib/bundler/man
+pkg
+pkg/*
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+tmtags
+tramp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--order random

data/.travis.yml

@@ -0,0 +1,4 @@
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3

data/.yardopts

@@ -0,0 +1,3 @@
+--markup markdown
+-
+LICENSE.md

data/Gemfile

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

data/LICENSE.md

@@ -0,0 +1,10 @@
+Copyright (c) 2012, Code for America
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+* Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+* Neither the name of Code for America nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,72 @@
+#Commons
+=======
+A Ruby wrapper for the Civic Commons MarketPlace API at [http://marketplace.civiccommons.org/api](http://marketplace.civiccommons.org/api)
+
+Does your project or organization use this gem?
+------------------------------------------
+Add it to the [apps](http://github.com/codeforamerica/commons/wiki/apps) wiki!
+
+Installation
+------------
+    $ gem install commons
+
+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
+--------------
+    require 'commons'
+
+	@client = Commons::Client::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.
+
+Here are some ways *you* can contribute:
+
+* by using alpha, beta, and prerelease versions
+* by reporting bugs
+* 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 refactoring code
+* by resolving [issues](http://github.com/codeforamerica/commons/issues)
+* by reviewing patches
+
+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
+-------------------------
+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)
+

data/Rakefile

@@ -0,0 +1,18 @@
+#!/usr/bin/env rake
+
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+task :test => :spec
+
+require 'yard'
+namespace :doc do
+  YARD::Rake::YardocTask.new do |task|
+    task.files   = ['LICENSE.md', 'lib/**/*.rb']
+    task.options = ['--markup', 'markdown']
+  end
+end

data/commons.gemspec

@@ -0,0 +1,27 @@
+# encoding: utf-8
+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 'hashie', '~> 1.2'
+  gem.add_dependency 'multi_json', '~> 1.0'
+  gem.add_dependency 'rash', '~> 0.3.2'
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rdiscount'
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'simplecov'
+  gem.add_development_dependency 'webmock'
+  gem.add_development_dependency 'yard'
+  gem.author      = "Code for America"
+  gem.description = %q{Ruby Wrapper for the Civic Commons MarketPlace API - http://marketplace.civiccommons.org/api}
+  gem.email       = 'ryan@codeforamerica.org'
+  gem.executables = `git ls-files -- bin/*`.split("\n").map{|f| File.basename(f)}
+  gem.files       = `git ls-files`.split("\n")
+  gem.homepage    = 'https://github.com/codeforamerica/commons'
+  gem.name        = 'commons'
+  gem.require_paths = ['lib']
+  gem.summary     = gem.description
+  gem.test_files  = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.version     = Commons::VERSION
+end

data/lib/commons.rb

@@ -0,0 +1,24 @@
+require 'commons/configuration'
+require 'commons/client'
+
+module Commons
+ extend Configuration
+  class << self
+    # Alias for Commons::Client.new
+    #
+    # @return [Commons::Client]
+    def new(options={})
+      Commons::Client.new(options)
+    end
+
+    # Delegate to Commons::Client.new
+    def method_missing(method, *args, &block)
+      return super unless new.respond_to?(method)
+      new.send(method, *args, &block)
+    end
+
+    def respond_to?(method, include_private=false)
+      new.respond_to?(method, include_private) || super(method, include_private)
+    end
+  end
+end

data/lib/commons/client.rb

@@ -0,0 +1,23 @@
+require 'commons/connection'
+require 'commons/request'
+
+require 'commons/client/content'
+
+module Commons
+  class Client
+    attr_accessor(*Configuration::VALID_OPTIONS_KEYS)
+
+    def initialize(options={})
+      options = Commons.options.merge(options)
+      Configuration::VALID_OPTIONS_KEYS.each do |key|
+        send("#{key}=", options[key])
+      end
+    end
+
+    include Commons::Connection
+    include Commons::Request
+
+    include Commons::Client::Content
+
+  end
+end

data/lib/commons/client/content.rb

@@ -0,0 +1,17 @@
+module Commons
+  class Client
+    module Content
+      # Use this query to get the information about one product
+      #
+      # @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
+      # @example
+      #   Comments.content("13351")
+      def content(id,options={})
+        get("node/#{id}.json", options)
+      end
+    end
+  end
+end

data/lib/commons/configuration.rb

@@ -0,0 +1,65 @@
+require 'commons/version'
+
+module Commons
+  # Defines constants and methods related to configuration
+  module Configuration
+    # An array of valid keys in the options hash when configuring a {SfPark::API}
+    VALID_OPTIONS_KEYS = [
+      :adapter,
+      :endpoint,
+      :proxy,
+      :response,
+      :user_agent,
+      :faraday_options].freeze
+
+    # The adapter that will be used to connect if none is set
+    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
+
+    # The response format appended to the path and sent in the 'Accept' header if none is set
+    #
+    # @note JSON is preferred over XML because it is more concise and faster to parse.
+    DEFAULT_RESPONSE = :json
+
+    # By default, don't use a proxy server
+    DEFAULT_PROXY = nil
+
+    # The value sent in the 'User-Agent' header if none is set
+    DEFAULT_USER_AGENT = "Commons Ruby Gem #{Commons::VERSION}".freeze
+
+    DEFAULT_FARADAY_OPTIONS = {}.freeze
+
+    # @private
+    attr_accessor *VALID_OPTIONS_KEYS
+
+    # When this module is extended, set all configuration options to their default values
+    def self.extended(base)
+      base.reset
+    end
+
+    # Convenience method to allow configuration options to be set in a block
+    def configure
+      yield self
+    end
+
+    # Create a hash of options and their values
+    def options
+      options = {}
+      VALID_OPTIONS_KEYS.each{|k| options[k] = send(k)}
+      options
+    end
+
+    # Reset all configuration options to defaults
+    def reset
+      self.adapter                = DEFAULT_ADAPTER
+      self.endpoint               = DEFAULT_ENDPOINT
+      self.proxy                  = DEFAULT_PROXY
+      self.user_agent             = DEFAULT_USER_AGENT
+      self.response               = DEFAULT_RESPONSE
+      self.faraday_options        = DEFAULT_FARADAY_OPTIONS
+      self
+    end
+  end
+end

data/lib/commons/connection.rb

@@ -0,0 +1,27 @@
+require 'faraday_middleware'
+
+module Commons
+  module Connection
+    private
+
+ def connection(options={})
+    merged_options = faraday_options.merge({
+        :headers => {
+          'Accept' => "application/#{response}",
+          'User-Agent' => user_agent
+        },
+        :ssl => {:verify => false},
+        :url => endpoint
+      })
+
+      Faraday.new(merged_options) do |builder|
+        builder.use Faraday::Request::UrlEncoded
+        builder.use Faraday::Response::RaiseError
+        builder.use Faraday::Response::Rashify
+        builder.use Faraday::Response::Mashify
+        builder.use Faraday::Response::ParseJson
+        builder.adapter(Faraday.default_adapter)
+      end
+    end
+  end
+end

data/lib/commons/request.rb

@@ -0,0 +1,16 @@
+module Commons
+  module Request
+    def get(path, options={})
+      request(:get, path, options)
+    end
+
+    private
+
+    def request(method, path, options)
+      response = connection.send(method) do |request|
+        request.url(path, options)
+      end
+      response.body
+    end
+  end
+end

data/lib/commons/version.rb

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

data/spec/commons/content_spec.rb

@@ -0,0 +1,22 @@
+require 'helper'
+
+describe Commons::Client::Content do
+  before do
+    @client = Commons.new
+  end
+
+  describe "#content" do
+    context "get content" do
+      before do
+        stub_get("/node/13813.json").
+          to_return(:status => 200, :body => fixture("nodes.json"))
+      end
+
+      it "should return search the correct content node" do
+        node = @client.content('13813')
+        node.title.should == "YouTown"
+      end
+    end
+
+  end
+end

data/spec/commons_spec.rb

@@ -0,0 +1,19 @@
+require 'helper'
+
+describe Commons do
+  after do
+    Commons.reset
+  end
+
+  describe ".respond_to?" do
+    it "should be true if method exists" do
+      Commons.respond_to?(:new, true).should be_true
+    end
+  end
+
+  describe ".new" do
+    it "should return a Commons::Client" do
+      Commons.new.should be_a Commons::Client
+    end
+  end
+end

data/spec/fixtures/nodes.json

@@ -0,0 +1 @@
+{"vid":"13824","uid":"150","title":"YouTown","log":"","status":"1","comment":"1","promote":"0","sticky":"0","nid":"13813","type":"application","language":"und","created":"1324420273","changed":"1325695955","tnid":"0","translate":"0","revision_timestamp":"1325695955","revision_uid":"195","field_application_sdesc":{"und":[{"value":"A mobile app platform built for all government agencies and departments","format":null,"safe_value":"A mobile app platform built for all government agencies and departments"}]},"field_application_logo":{"und":[{"fid":"678","alt":"","title":"","uid":"150","filename":"DotGov logo 338x112 (1).png","uri":"public://content/applications/logos/DotGov logo 338x112 (1).png","filemime":"image/png","filesize":"15975","status":"1","timestamp":"1324420757","type":"image","rdf_mapping":[]}]},"field_application_rlss":[],"field_application_relapps":[],"field_application_featurs":[],"field_application_type":[],"field_application_creator":{"und":[{"nid":"13811"}]},"field_application_vendors":[],"field_application_hostname":[],"field_application_hosturl":[],"field_application_demourl":[],"field_application_license":[],"field_application_rating":{"und":[{"rating":null,"target":null}]},"field_application_description":{"und":[{"value":"Big-time metropolis? Small-budget township? YouTown brings a ready-made mobile platform to connect with your citizens to ANY community.\r\n\r\nConnecting busy citizens to their local governments can be tough. As more and more people rely on their mobile devices for handling day-to-day information and tasks, many cities are asking, \u201cHow can we take the initiative and make civic data available to our citizens in a mobile format?\u201d\r\n\r\nThe answer is simpler than you might think. No need to build your own application or break the budget. YouTown provides the platform, you provide the data -- and your community reaps the benefits.","format":"filtered_html","safe_value":"<p>Big-time metropolis? Small-budget township? YouTown brings a ready-made mobile platform to connect with your citizens to ANY community.</p>\n<p>Connecting busy citizens to their local governments can be tough. As more and more people rely on their mobile devices for handling day-to-day information and tasks, many cities are asking, \u201cHow can we take the initiative and make civic data available to our citizens in a mobile format?\u201d</p>\n<p>The answer is simpler than you might think. No need to build your own application or break the budget. YouTown provides the platform, you provide the data -- and your community reaps the benefits.</p>\n"}]},"field_application_reqs":[],"field_application_deliverymeth":[],"field_application_civfunction":{"und":[{"tid":"206"}]},"field_application_softfunction":[],"field_application_projects":[],"field_application_interactions":{"und":[{"nid":"13812"},{"nid":"13818"},{"nid":"13838"},{"nid":"13861"},{"nid":"13863"},{"nid":"13921"},{"nid":"13927"},{"nid":"13951"},{"nid":"13967"}]},"field_application_screenshots":[],"field_application_tutors":[],"field_application_ss_id":[],"field_application_homepage":{"und":[{"url":"http://youtown.com","title":null,"attributes":[]}]},"field_project_resulted":[],"field_application_stds":[],"field_application_tags":[],"rdf_mapping":{"rdftype":["sioc:Item","foaf:Document"],"title":{"predicates":["dc:title"]},"created":{"predicates":["dc:date","dc:created"],"datatype":"xsd:dateTime","callback":"date_iso8601"},"changed":{"predicates":["dc:modified"],"datatype":"xsd:dateTime","callback":"date_iso8601"},"body":{"predicates":["content:encoded"]},"uid":{"predicates":["sioc:has_creator"],"type":"rel"},"name":{"predicates":["foaf:name"]},"comment_count":{"predicates":["sioc:num_replies"],"datatype":"xsd:integer"},"last_activity":{"predicates":["sioc:last_activity_date"],"datatype":"xsd:dateTime","callback":"date_iso8601"}},"cid":"0","last_comment_timestamp":"1324420273","last_comment_name":null,"last_comment_uid":"150","comment_count":"0","name":"sidburgess","picture":"0","data":null,"path":"http://marketplace.civiccommons.org/apps/youtown"}

data/spec/helper.rb

@@ -0,0 +1,25 @@
+require 'simplecov'
+SimpleCov.start
+require 'commons'
+require 'rspec'
+require 'webmock/rspec'
+
+def a_get(url)
+  a_request(:get, commons_url(url))
+end
+
+def stub_get(url)
+  stub_request(:get, commons_url(url))
+end
+
+def fixture_path
+  File.expand_path("../fixtures", __FILE__)
+end
+
+def fixture(file)
+  File.new(fixture_path + '/' + file)
+end
+
+def commons_url(url)
+  "http://marketplace.civiccommons.org/api/v1#{url}"
+end

metadata

@@ -0,0 +1,191 @@
+--- !ruby/object:Gem::Specification
+name: commons
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Code for America
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-01-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: &70211068357580 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70211068357580
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: &70211068356580 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70211068356580
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: &70211068351920 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70211068351920
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: &70211068350480 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70211068350480
+- !ruby/object:Gem::Dependency
+  name: rash
+  requirement: &70211068349100 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.3.2
+  type: :runtime
+  prerelease: false
+  version_requirements: *70211068349100
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70211068348560 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70211068348560
+- !ruby/object:Gem::Dependency
+  name: rdiscount
+  requirement: &70211068348100 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70211068348100
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70211068347520 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70211068347520
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: &70211068346780 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70211068346780
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: &70211068346360 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70211068346360
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: &70211068345920 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70211068345920
+description: Ruby Wrapper for the Civic Commons MarketPlace API - http://marketplace.civiccommons.org/api
+email: ryan@codeforamerica.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gemtest
+- .gitignore
+- .rspec
+- .travis.yml
+- .yardopts
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- commons.gemspec
+- lib/commons.rb
+- lib/commons/client.rb
+- lib/commons/client/content.rb
+- lib/commons/configuration.rb
+- lib/commons/connection.rb
+- lib/commons/request.rb
+- lib/commons/version.rb
+- spec/commons/content_spec.rb
+- spec/commons_spec.rb
+- spec/fixtures/nodes.json
+- spec/helper.rb
+homepage: https://github.com/codeforamerica/commons
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: Ruby Wrapper for the Civic Commons MarketPlace API - http://marketplace.civiccommons.org/api
+test_files:
+- spec/commons/content_spec.rb
+- spec/commons_spec.rb
+- spec/fixtures/nodes.json
+- spec/helper.rb
+has_rdoc: