seeclickfix 0.0.5

data/.autotest

@@ -0,0 +1 @@
+require 'autotest/bundler'

data/.gitignore

@@ -0,0 +1,41 @@
+!.gitignore
+*.gem
+*.rbc
+*.sw[a-p]
+*.tmproj
+*.tmproject
+*.un~
+*~
+.DS_Store
+.Spotlight-V100
+.Trashes
+._*
+.bundle
+.config
+.directory
+.elc
+.redcar
+.yardoc
+/.emacs.desktop
+/.emacs.desktop.lock
+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,3 @@
+--color
+--format=nested
+--backtrace

data/.travis.yml

@@ -0,0 +1,7 @@
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - rbx
+  - rbx-2.0
+  - ree

data/.yardopts

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

data/Gemfile

@@ -0,0 +1,10 @@
+source 'http://rubygems.org'
+
+
+platforms :jruby do 
+	gem 'jruby-openssl', '~> 0.7.4'
+end
+# Specify your gem's dependencies in seeclickfix.gemspec
+gemspec
+
+

data/LICENSE.md

@@ -0,0 +1,10 @@
+Copyright (c) 2011, 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 @@
+SeeClickFix API
+=======
+A Ruby wrapper for the SeeClickFix APIs at [http://help.seeclickfix.com/kb/api/api-overview](http://help.seeclickfix.com/kb/api/api-overview)
+
+Does your project or organization use this gem?
+------------------------------------------
+Add it to the [apps](http://github.com/codeforamerica/seeclickfix_rb/wiki/apps) wiki!
+
+Installation
+------------
+    $ gem install seeclickfix
+
+Documentation
+-------------
+[http://rdoc.info/gems/seeclickfix](http://rdoc.info/gems/seeclickfix)
+
+Continuous Integration
+----------------------
+[![Build Status](https://secure.travis-ci.org/codeforamerica/seeclickfix_rb.png)](http://travis-ci.org/codeforamerica/seeclickfix_rb)
+
+Usage Examples
+--------------
+    require 'seeclickfix'
+
+	@client = SeeClickFix::Client::New
+	a = @client.list_issues("San Francisco")
+	a.first.issue_id # => 108657
+
+
+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/seeclickfix_rb/issues)
+* by reviewing patches
+
+Submitting an Issue
+-------------------
+We use the [GitHub issue tracker](http://github.com/codeforamerica/seeclickfix_rb/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/seeclickfix_rb/blob/master/LICENSE.md) for details.
+
+[![Code for America Tracker](http://stats.codeforamerica.org/codeforamerica/seeclickfix_rb.png)](http://stats.codeforamerica.org/projects/seeclickfix_rb)

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/lib/seeclickfix.rb

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

data/lib/seeclickfix/client.rb

@@ -0,0 +1,31 @@
+require 'seeclickfix/connection'
+require 'seeclickfix/request'
+
+require 'seeclickfix/client/comments'
+require 'seeclickfix/client/issues'
+require 'seeclickfix/client/service_request_questions'
+require 'seeclickfix/client/service_request_types'
+require 'seeclickfix/client/watch_areas'
+
+module SeeClickFix
+  class Client
+    attr_accessor *Configuration::VALID_OPTIONS_KEYS
+
+    def initialize(options={})
+      options = SeeClickFix.options.merge(options)
+      Configuration::VALID_OPTIONS_KEYS.each do |key|
+        send("#{key}=", options[key])
+      end
+    end
+
+    include SeeClickFix::Client::Connection
+    include SeeClickFix::Request
+
+    include SeeClickFix::Client::Comments
+    include SeeClickFix::Client::Issues
+    include SeeClickFix::Client::ServiceRequestQuestions
+    include SeeClickFix::Client::ServiceRequestTypes
+    include SeeClickFix::Client::WatchAreas
+
+  end
+end

data/lib/seeclickfix/client/comments.rb

@@ -0,0 +1,38 @@
+module SeeClickFix
+  class Client
+    module Comments
+
+      # Use this query the comments and history of a single issue.
+      #
+      # @param issue [String] The issue number for the query
+      # @param options [Hash] A customizable set of options.
+      # @return [Array<Hashie::Mash>]
+      # @see http://help.seeclickfix.com/kb/api/listing-comments-and-issue-history
+      # @example
+      #   SeeClickFix.list_comments("1050")
+      def list_comments(issue, options={})
+        get("api/issues/#{issue}/comments.json", options)
+      end
+
+      # Add a comment to an issue
+      #
+      # @param issue [String] The issue number for the query
+      # @param api_key [String] API Key
+      # @param comment [String] Comment to add
+      # @param comment_email [String] Email of the person making the comment
+      # @param options [Hash] A customizable set of options.
+      # @options options comment[name]  Name of the person making the comment.
+      # @options options comment[send_email] Subscribe the email added to all comments.
+      # @options options comment[youtube_url] URL of a youtube video to add.
+      # @options options comment[comment_image_attributes][uploaded_data] Image to add to the comment.
+      # @return [Array<Hashie::Mash>]
+      # @see http://help.seeclickfix.com/kb/api/adding-a-comment
+      # @example
+      #   SeeClickFix.create_comment("7000", "hello", "joe@myemail.com")
+      def create_comment(issue, comment, comment_email, options={})
+        post("api/issues/#{issue}/comments.json?comment[comment]=#{comment}&comment[email]=#{comment_email}", options)
+      end
+
+    end
+  end
+end

data/lib/seeclickfix/client/issues.rb

@@ -0,0 +1,83 @@
+module SeeClickFix
+  class Client
+    module Issues
+
+      # Returns a list of issues for the location Data is returned in chunks of num_results. You can increment the page parameter to get the next group of results. If page exceeds the total number of pages the result will be an empty array
+      #
+      # @param location [String] Geocodable street address. e.g. zipcode, city, state or 123 state st. new haven, ct.
+      # @option options zoom [String] Integer level from 0 to 19 based on google maps.
+      # @param options [Hash] A customizable set of options.
+      # @option options lat [String] Lattitude
+      # @option options lon [String] Longitude
+      # @option options lat_min [String] Minimum lattitude
+      # @option options lon_min [String] Minimum longitude
+      # @option options lat_max [String] Maximum lattitude
+      # @option options lon_max [String] Maximum longitude
+      # @option options status [String] Open Set equal to "true" to see open issues. If status is not set the API returns Open, Closed, and Acknowledged issues.
+      # @option options status [String] Closed Set equal to "true" to see closed issues. If status is not set the API returns Open, Closed, and Acknowledged issues.
+      # @option options status [String] Acknowledged Set equal to "true" to see acknowledged issues. If status is not set the API returns Open, Closed, and Acknowledged issues.
+      # @option options status [String] Archived Set equal to "true" to see archived issues. If status is not set the API returns Open, Closed, and Acknowledged issues.
+      # @option options start [String] The number of hours ago the oldest issue can be. Partial hours can be in decimal format, for example 0.25 shows reports in the last 15min.
+      # @option options end [String] The number of hours ago the youngest issue can be.
+      # @option options num_results [Integer] The maximum number of results to return (default 10, maximum 1000).
+      # @option options page [Integer] If the number of results exceeds num_results, page can increment the range.
+      # @option options search [String] A query string to limit the results by.
+      # @option options sort [String] A parameter to sort the results by. Possible values include: issues.updated_at - Date last updated
+      # @option options Issues.created_at [String] Date Created
+      # @option options Issues.rating [String] Issue Rating
+      # @option options Issues.hot [String]  Issue Hotness
+      # @option options direction [String] Sort direction. Possible values include: ASC - Ascending
+      # @option options DESC [String] Descending.
+      # @option options request_tags [String] Limit results to issues with service request tags. Service request tags are automatically added to issues when issues are reported to a specific service request. Multiple request tags can be found using the form "request_type_[request_type_id],request_type_[request_type_id],request_type_[request_type_id]".
+      # @return [Array<Hashie::Mash>]
+      # @see http://help.seeclickfix.com/kb/api/listing-issues
+      # @example
+      #   SeeClickFix.list_issues("San Francisco")
+      def list_issues(location, options={})
+        get("api/issues.json?at=#{location}", options)
+      end
+
+      # Use this query to get details on a single issue. There may be more information in this query than the issue listing query.
+      #
+      # @param issue [String] The issue number for the query
+      # @param options [Hash] A customizable set of options.
+      # @return [Array<Hashie::Mash>]
+      # @see http://help.seeclickfix.com/kb/api/querying-an-issue
+      # @example
+      #   SeeClickFix.issue_details("1050")
+      def issue_details(issue, options={})
+        get("api/issues/#{issue}.json", options)
+      end
+
+      # Use this query to get details on a single issue. There may be more information in this query than the issue listing query.
+      #
+      # @param summary [String] Summary of the problem
+      # @param lat [String] Latitude of the issue.
+      # @param lng [String] Longitude of the issue.
+      # @param api_key [String] Api key
+      # @param options [Hash] A customizable set of options.
+      # @option options issue[description] [String] Longer text describing the problem.
+      # @option options issue[address] [String] Text representation of the location of the issue.
+      # @option options issue[reporter_email] [String] Email of the person reporting the issue.
+      # @option options issue[reporter_display] [String] Text display of the person reporting the issue.
+      # @option options issue[issue_image_attributes][uploaded_data] [String] Attach an image to the issue. Form data must be sent as "multipart/form-data".
+      # @option options issue[request_type_id] [String] If submitting to a service request, specify the service request ID here. By adding this attribute, additional validations are required, including: 1. Making sure the service request can be within the given boundaries. 2. Making sure all of the required additional questions are completed.
+      # For each service request question provide the following parameters.
+      # @option options issue[request_type_answers_attributes][][request_type_question_primary_key] [String] Primary key of the service request question.
+      # @option options issue[request_type_answers_attributes][][answer] [String] Answer to the service request question.
+      # @return [Array<Hashie::Mash>]
+      # @see http://help.seeclickfix.com/kb/api/creating-an-issue
+      # @example
+      #   SeeClickFix.issue_details("1050")
+      #
+      # @return [Array<Hashie::Mash>]
+      # @see http://help.seeclickfix.com/kb/api/querying-an-issue
+      # @example
+      #   SeeClickFix.create_details("foo","41.3103725899427", "-72.9241595114853") http://seeclickfix.com/api/issues.xml
+      def create_issue(summary, lat, lng, options={})
+        post("api/issues.json?issue[summary]=#{summary}&issue[lat]=#{lat}&issue[lng]=#{lng}")
+      end
+
+    end
+  end
+end

data/lib/seeclickfix/client/service_request_questions.rb

@@ -0,0 +1,19 @@
+module SeeClickFix
+  class Client
+    module ServiceRequestQuestions
+
+      # Given a service request ID (chosen from the list of valid service request types), list the additional questions that need to be asked.
+      #
+      # @param request_type_id [String] Service request ID. A valid service request type ID
+      # @option api_key [String] API Key
+      # @param options [Hash] A customizable set of options.
+      # @return [Array<Hashie::Mash>]
+      # @see http://help.seeclickfix.com/kb/api/list-service-request-type-questions
+      # @example
+      #   SeeClickFix.service_request_types("1")
+      def service_request_type_questions(request_type_id,options={})
+        get("api/request_types/#{request_type_id}/request_type_questions.json", options)
+      end
+    end
+  end
+end

data/lib/seeclickfix/client/service_request_types.rb

@@ -0,0 +1,21 @@
+module SeeClickFix
+  class Client
+    module ServiceRequestTypes
+
+      # Use this query to list valid service request types (things like pothole, graffiti, street light out etc.) for a given location.
+      #
+      # @param lat [String] Latitude to check for service request types.
+      # @param long [String] Longitude to check for service request types.
+      # @option api_key [String] API Key
+      # @param options [Hash] A customizable set of options.
+      # @return [Array<Hashie::Mash>]
+      # @see http://help.seeclickfix.com/kb/api/list-service-request-types
+      # @example
+      #   SeeClickFix.service_request_types("32.1610815588945","-110.87677001953125")
+      def service_request_types(lat,lng,options={})
+        get("api/request_types/at.json?lat=#{lat}&lng=#{lng}", options)
+      end
+
+    end
+  end
+end

data/lib/seeclickfix/client/watch_areas.rb

@@ -0,0 +1,26 @@
+module SeeClickFix
+  class Client
+    module WatchAreas
+
+      # Use this query to list public watch areas at a given location.
+      #
+      # @param options [Hash] A customizable set of options.
+      # @option options at [String] Geocodable street address. e.g. zipcode, city, state or 123 state st. new haven, ct.
+      # @option options zoom [String] Integer level from 0 to 19 based on google maps.
+      # @option options lat [String] Lattitude
+      # @option options lon [String] Longitude
+      # @option options lon [String] Longitude
+      # @option options radius [String] Radius to search for watch areas by. Radius is in units of degrees. Default is 1.
+      # @option options watcher_search [String] Search terms to limit the results by.
+      # @option options page [String] Page to display the results as. Results are sorted by distance from the required parameter area's center. Default is 1.
+      # @option options num_results [Integer] Number of results to return. Default is 20
+      # @return [Array<Hashie::Mash>]
+      # @see http://help.seeclickfix.com/kb/api/list-watch-areas
+      # @example
+      #   SeeClickFix.watch_areas({:at => "San Francisco"})
+      def watch_areas(options={})
+        get("api/watchers/list.json", options)
+      end
+    end
+  end
+end

data/lib/seeclickfix/configuration.rb

@@ -0,0 +1,53 @@
+require 'faraday'
+require 'seeclickfix/version'
+
+module SeeClickFix
+  module Configuration
+    VALID_OPTIONS_KEYS = [
+      :adapter,
+      :api_key,
+      :api_version,
+      :login,
+      :password,
+      :proxy,
+      :token,
+      :oauth_token,
+      :user_agent].freeze
+
+    DEFAULT_ADAPTER     = Faraday.default_adapter
+    DEFAULT_API_KEY     = nil
+    DEFAULT_API_VERSION = nil
+    DEFAULT_LOGIN       = nil
+    DEFAULT_PASSWORD    = nil
+    DEFAULT_PROXY       = nil
+    DEFAULT_TOKEN       = nil
+    DEFAULT_OAUTH_TOKEN = nil
+    DEFAULT_USER_AGENT  = "SeeClickFix Ruby Gem #{SeeClickFix::VERSION}".freeze
+
+    attr_accessor *VALID_OPTIONS_KEYS
+
+    def self.extended(base)
+      base.reset
+    end
+
+    def configure
+      yield self
+    end
+
+    def options
+      VALID_OPTIONS_KEYS.inject({}){|o,k| o.merge!(k => send(k)) }
+    end
+
+    def reset
+      self.adapter     = DEFAULT_ADAPTER
+      self.api_key     = DEFAULT_API_KEY
+      self.api_version = DEFAULT_API_VERSION
+      self.login       = DEFAULT_LOGIN
+      self.password    = DEFAULT_PASSWORD
+      self.proxy       = DEFAULT_PROXY
+      self.token       = DEFAULT_TOKEN
+      self.oauth_token = DEFAULT_OAUTH_TOKEN
+      self.user_agent  = DEFAULT_USER_AGENT
+    end
+  end
+end