easy311 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in easy311.gemspec
+gemspec
+
+group :test do
+  gem "factory_girl"
+  gem "rspec", "~> 2.12"
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Jimmy Bourassa
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,39 @@
+# Easy311
+
+Easy311 is a set of tools to ease the development of Open311 applications:
+it provides a wrapper around the REST API and a close-to-compliant ActiveModel
+`Request` object.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'easy311'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install easy311
+
+If you want to use `Easy311::Rails`, copy and edit easy311.yml
+to `#{Rails.root}/config/easy311.yml`
+
+## Usage
+
+The library can be used by itself without Rails, but we built a wrapper
+for Rails that makes it easy to configure and load Open311's services.
+
+No documentation official documentation has been written (yet) since
+this library has originally been built during a Hackaton (see credits).
+
+## Contributing
+
+No contribution is too small: fork away and send pull requests!
+
+## Credits
+
+This gem has been extracted from 2013 [Iron Web](http://ironweb.org)
+_Rouges_' team. Original code by @gelendir and @jbourassa.

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/easy311.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'easy311/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "easy311"
+  gem.version       = Easy311::VERSION
+  gem.authors       = ["Jimmy Bourassa", "Gregory Eric Sanderson"]
+  gem.email         = ["jimmy.bourassa@hooktstudios.com", "gzou2000@gmail.com"]
+  gem.description   = %q{Set of tools to ease the development of Open311 applications}
+  gem.summary       = %q{Easy311 is a set of tools to ease the development of
+                         Open311 applications: it provides a wrapper around the
+                         REST API and a close-to-compliant ActiveModel
+                         `Request` object.}
+  gem.homepage      = "https://github.com/jbourassa/easy311"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency('active_attr')
+  gem.add_dependency('rest-client')
+end

data/easy311.yml

@@ -0,0 +1,4 @@
+# This is a sample configuration file for Easy311
+url: __URL__
+apikey: __API_KEY__
+jurisdiction_id: _ID__

data/lib/easy311.rb

@@ -0,0 +1,11 @@
+require "active_attr"
+require "easy311/version"
+require "easy311/request"
+require "easy311/api_wrapper"
+require "easy311/service"
+require "easy311/attribute"
+require "easy311/response"
+require "easy311/rails" if defined?(Rails)
+
+module Easy311
+end

data/lib/easy311/api_wrapper.rb

@@ -0,0 +1,134 @@
+require 'rest-client'
+require 'json'
+require 'easy311/service'
+require 'easy311/attribute'
+require 'logger'
+
+module Easy311
+
+  class ApiWrapper
+
+    attr_accessor :logger
+
+    def self.from_url(url, api_key, jurisdiction_id=nil)
+      resource = RestClient::Resource.new(url)
+      return self.new(resource, api_key, jurisdiction_id)
+    end
+
+    def initialize(resource, api_key, jurisdiction_id=nil)
+      @resource = resource
+      @api_key = api_key
+      @jurisdiction_id = jurisdiction_id
+    end
+
+    def log
+      @logger ||= Easy311.logger
+    end
+
+    def all_services
+      log.info "querying list of services"
+      response = query_service('/services.json')
+      return [] if response.empty?
+
+      raw_services = JSON.parse(response)
+      services = raw_services.map { |r| Service.new(r) }
+
+      return services
+    end
+
+    def group_names
+      all_services.map { |s| s.group }.uniq
+    end
+
+    def groups
+      all_services.group_by { |s| s.group }
+    end
+
+    def attrs_from_code(code)
+      log.info "querying attributes for service #{code}"
+      url = "/services/#{code}.json"
+      response = query_service(url)
+      return [] if response.empty?
+
+      json_data = JSON.parse(response)
+      raw_attrs = json_data['attributes']
+      return [] if raw_attrs.empty?
+
+      attrs = raw_attrs.map { |a| Attribute.new(a) }
+
+      return attrs
+    end
+
+    def services_with_attrs
+      log.info "querying all services and attributes"
+      services = all_services.map do |service|
+        service.attrs = attrs_from_code(service.code)
+        service
+      end
+      return services
+    end
+
+    def query_service(path)
+      params = build_params
+      log.debug "GET #{path}"
+      response = @resource[path].get(params)
+      log.debug "RESPONSE #{response}"
+      return response.strip
+    end
+
+    def build_params
+      params = {}
+      params[:jurisdiction_id] = @jurisdiction_id unless @jurisdiction_id.nil?
+      return params
+    end
+
+    def send_request(request)
+      log.info "sending request #{request}"
+
+      params = request.to_post_params
+      params['api_key'] = @api_key
+      log.debug "params #{params}"
+
+      response = @resource['/requests.json'].post(params) do |http_response|
+        log.debug "RESPONSE #{http_response.code} #{http_response.body}"
+        if http_response.code.to_i >= 400
+          parse_error_response(http_response.body)
+        else
+          parse_post_response(http_response.body)
+        end
+      end
+
+      log.info "response #{response}"
+      return response
+    end
+
+    def parse_post_response(body)
+      json_response = JSON.parse(body)
+      return Response.new(json_response.first)
+    end
+
+    def parse_error_response(body)
+      json_response = JSON.parse(body)
+      response = Response.new
+      response.error_message = json_response.map { |r| r['description'] }.join(",")
+      return response
+    end
+
+  end
+
+  def self.logger=(logger)
+    @logger = logger
+  end
+
+  def self.logger
+    @logger ||= rails_logger || default_logger
+  end
+
+  def self.rails_logger
+    defined?(::Rails) && ::Rails.respond_to?(:logger) && ::Rails.logger
+  end
+
+  def self.default_logger
+    Logger.new(STDOUT)
+  end
+end

data/lib/easy311/attribute.rb

@@ -0,0 +1,17 @@
+module Easy311
+
+  class Attribute
+    include ActiveAttr::Model
+
+    attribute :code
+    attribute :datatype
+    attribute :description
+    attribute :datatype_description
+    attribute :order
+    attribute :required
+    attribute :values
+    attribute :variable
+
+  end
+
+end

data/lib/easy311/factories.rb

@@ -0,0 +1,65 @@
+# encoding: utf-8
+FactoryGirl.define do
+  factory :easy311_service, :class => 'Easy311::Service' do
+    service_code "1934303d-7f43-e111-85e1-005056a60032"
+    service_name "Collecte des encombrants - secteur résidentiel"
+    group "Ordures"
+    description "Description à venir"
+    metadata true
+    type "batch"
+
+    trait :with_optionnal do
+      keywords "Collecte,Encombrants,Gros déchets,Grosses poubelles,Grosses vidanges,Meubles,Monstres"
+    end
+  end
+
+  factory :easy311_attribute, :class => 'Easy311::Attribute' do
+    code "7041ac51-ec75-e211-9483-005056a613ac"
+    datatype "text"
+    datatype_description  "Pour disposer d`appareils contenant des halocarbures (congélateur réfrigérateur climatiseur etc.) veuillez communiquer avec votre bureau d'arrondissement."
+    description  "Pour disposer d`appareils contenant des halocarbures (congélateur réfrigérateur climatiseur etc.) veuillez communiquer avec votre bureau d'arrondissement."
+    order 2
+    required false
+    values []
+    variable false
+  end
+
+  factory :easy311_request, :class => 'Easy311::Request' do
+    ignore do
+      service :nil
+    end
+
+    lat 12.34
+    long 56.78
+
+    initialize_with { new(FactoryGirl.build(:easy311_service)) }
+  end
+
+  factory :easy311_request_full, :class => 'Easy311Request' do
+    ignore do
+      service :nil
+    end
+
+    description "desc"
+    lat 12.34
+    long 56.78
+    email "email@test.com"
+    device_id 1
+    account_id 2
+    first_name "firstname"
+    last_name "lastname"
+    phone "55512345678"
+    description "description"
+    media_url "http://url"
+
+    initialize_with { new(FactoryGirl.build(:easy311_service)) }
+  end
+
+  factory :easy311_response, :class => 'Easy311::Response' do
+    token "53020772-c676-e211-9483-005056a613ac"
+    service_request_id nil
+    service_notice nil
+    account_id nil
+    error_message nil
+  end
+end

data/lib/easy311/rails.rb

@@ -0,0 +1,35 @@
+module Easy311
+  module Rails
+
+    CACHE_KEY = 'easy311_services'
+
+    def self.config_path
+      "#{::Rails.root}/config/easy311.yml"
+    end
+
+    def self.load_config
+      YAML.load(ERB.new(IO.read(config_path)).result)
+    end
+
+    def self.load_all_services!
+      api_wrapper = self.api_wrapper
+      services = api_wrapper.services_with_attrs
+
+      ::Rails.cache.write CACHE_KEY, services
+    end
+
+    def self.all_services
+      ::Rails.cache.read(CACHE_KEY) || load_all_services!
+    end
+
+    def self.api_wrapper
+      api_config = load_config
+      url = api_config['url']
+      jurisdiction_id = api_config['jurisdiction_id']
+      api_key = api_config['apikey']
+
+      ApiWrapper.from_url(url, api_key, jurisdiction_id)
+    end
+
+  end
+end

data/lib/easy311/request.rb

@@ -0,0 +1,91 @@
+require 'active_support/core_ext/hash/indifferent_access'
+module Easy311
+  class Request
+    include ActiveAttr::Model
+
+    attribute :description
+    attribute :email
+    attribute :first_name
+    attribute :last_name
+    attribute :phone
+    attribute :password
+    attribute :lat
+    attribute :long
+    attribute :device_id
+    attribute :account_id
+    attribute :media_url
+
+    attr_reader :service
+    attr_accessor :attrs_values
+
+    POST_KEYS = [
+      :service_code,
+      :description,
+      :lat,
+      :long,
+      :email,
+      :device_id,
+      :account_id,
+      :first_name,
+      :last_name,
+      :phone,
+      :description,
+      :media_url,
+    ]
+
+    # TODO : Move out of Easy311 to our app -> not required by the spec
+    validates :email, :presence => true
+    validate :validate_required_attrs
+
+    def initialize(service)
+      @attrs_values = ActiveSupport::HashWithIndifferentAccess.new
+      @service = service
+    end
+
+    def attributes
+      super.merge("attrs" => Hash[service.attrs.map { |k, v| [k.to_s, self.send(k)]}])
+    end
+
+    def method_missing(method, *args, &block)
+      attr_name = method.to_s.gsub(/=$/, '')
+      if service.attrs.has_key?(attr_name)
+        if method.to_s.match(/=$/)
+          @attrs_values[attr_name] = args.first
+        else
+          @attrs_values[attr_name]
+        end
+      else
+        super
+      end
+    end
+
+    def respond_to?(method, include_private=false)
+      if service.attrs.has_key?(method.to_s.gsub(/=$/, ''))
+        true
+      else
+        super
+      end
+    end
+
+    def to_post_params
+      params = attributes.select { |k,v| !v.nil? and POST_KEYS.include? k.to_sym }
+      params['service_code'] = @service.code if @service.code
+
+      attrs_values.each do |key, value|
+        param_key = "attribute[#{key}]"
+        params[param_key] = value
+      end
+
+      params
+    end
+
+    private
+    def validate_required_attrs
+      required_attrs = @service.attrs.select { |code, attr| attr.required }.keys
+      return if required_attrs.empty?
+      validator = ActiveModel::Validations::PresenceValidator.new(
+        attributes: required_attrs)
+      validator.validate(self)
+    end
+  end
+end

data/lib/easy311/response.rb

@@ -0,0 +1,22 @@
+module Easy311
+
+  class Response
+    include ActiveAttr::Model
+
+    attribute :service_request_id
+    attribute :token
+    attribute :service_notice
+    attribute :account_id
+    attribute :error_message
+
+    def valid?
+      error_message.nil?
+    end
+
+    def invalid?
+      !valid?
+    end
+
+  end
+
+end

data/lib/easy311/service.rb

@@ -0,0 +1,41 @@
+module Easy311
+
+  class Service
+    include ActiveAttr::Model
+
+    attribute :name
+    attribute :code
+    attribute :group
+    attribute :description
+    attribute :metadata
+    attribute :type
+    attribute :attrs, :default => {}
+
+    def service_name=(value)
+      self.name = value
+    end
+
+    def service_code=(value)
+      self.code = value
+    end
+
+    def attrs=(values)
+      if values.is_a?(Array)
+        super Hash[values.map { |value| [value.code, value] }]
+      elsif values.is_a?(Hash)
+        super values
+      else
+        raise TypeError
+      end
+    end
+
+    def ordered_attrs
+      Hash[attrs.sort_by { |k, v| v.code }]
+    end
+
+    def to_param
+      code
+    end
+  end
+
+end

data/lib/easy311/version.rb

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

data/spec/easy311/api_wrapper_spec.rb

@@ -0,0 +1,298 @@
+# encoding: UTF-8
+require 'spec_helper'
+require 'easy311/json_helper.rb'
+require 'json'
+
+class ResponseStub
+
+  def initialize(response)
+    @response = response
+  end
+
+  def get(params)
+    return @response
+  end
+
+end
+
+class GetStub
+  attr_accessor :get
+
+  def initialize
+    @responses = {}
+  end
+
+  def add_response(url, response)
+    @responses[url] = response
+  end
+
+  def [](key)
+    return ResponseStub.new(@responses[key])
+  end
+
+end
+
+class PostStub
+
+  def initialize(response)
+    @response = response
+  end
+
+  def [](key)
+    return self
+  end
+
+  def post(payload)
+    code = 200
+    @result = payload
+    resp = Struct.new(:code, :body).new(code, @response)
+    yield resp
+  end
+
+  def post_result
+    @result
+  end
+
+end
+
+class ErrorStub < PostStub
+
+  def post(payload)
+    code = 400
+    body = "[{\"code\":\"Forbidden\",\"description\":\"'api_key' : L'argument ne peut pas \xC3\xAAtre null ou vide.\"}]"
+    response = Struct.new(:code, :body).new(code, body)
+    yield response
+  end
+
+end
+
+api_key = "12345678-1234-A1B2-C3D4-AA1A111A1A1A"
+
+describe Easy311::ApiWrapper do
+
+  it "returns an empty list when no services" do
+    resource = GetStub.new
+    resource.add_response('/services.json', "")
+
+    wrapper = Easy311::ApiWrapper.new(resource, api_key)
+    wrapper.all_services.should == []
+  end
+
+  it "returns once service" do
+    resource = GetStub.new()
+    service_json = [sample_service].to_json
+    resource.add_response('/services.json', service_json)
+
+    wrapper = Easy311::ApiWrapper.new(resource, api_key)
+    all_services = wrapper.all_services
+
+    all_services.length.should == 1
+    service = all_services.first
+
+    service.name.should == sample_service['service_name']
+    service.code.should == sample_service['service_code']
+    service.group.should == sample_service['group']
+    service.description.should == sample_service['description']
+    service.metadata.should == sample_service['metadata']
+    service.type.should ==  sample_service['type']
+    service.to_param.should == sample_service['service_code']
+  end
+
+  it "returns a service with minimal keys" do
+    resource = GetStub.new
+    service_json = [min_sample_service].to_json
+    resource.add_response('/services.json', service_json)
+
+    wrapper = Easy311::ApiWrapper.new(resource, api_key)
+    all_services = wrapper.all_services
+
+    all_services.length.should == 1
+    service = all_services[0]
+
+    service.name.should == sample_service['service_name']
+    service.code.should == sample_service['service_code']
+    service.group.should == sample_service['group']
+    service.description.should == sample_service['description']
+    service.metadata.should == sample_service['metadata']
+    service.type.should ==  sample_service['type']
+    service.to_param.should == sample_service['service_code']
+  end
+
+  it "returns the names of the groups" do
+    resource = GetStub.new
+    service_json = [min_sample_service].to_json
+    resource.add_response('/services.json', service_json)
+
+    wrapper = Easy311::ApiWrapper.new(resource, "1234")
+
+    wrapper.group_names.should == ["Ordures"]
+  end
+
+  it "returns a single group name with 2 services" do
+    resource = GetStub.new
+    service_json = [sample_service, sample_service].to_json
+    resource.add_response('/services.json', service_json)
+
+    wrapper = Easy311::ApiWrapper.new(resource, "1234")
+
+    result = ["Ordures"]
+    expect(wrapper.group_names).to eq(result)
+  end
+
+  it "returns a single group name with 2 services" do
+    resource = GetStub.new
+    second_service = sample_service.dup
+    second_service['group'] = 'Trottoirs'
+    service_json = [sample_service, second_service].to_json
+    resource.add_response('/services.json', service_json)
+
+    wrapper = Easy311::ApiWrapper.new(resource, api_key)
+
+    result = ["Ordures", "Trottoirs"]
+    wrapper.group_names.should == result
+  end
+
+  it "groups services together" do
+    resource = GetStub.new
+    second_service = sample_service.dup
+    second_service['group'] = 'Trottoirs'
+    service_json = [sample_service, second_service].to_json
+    resource.add_response('/services.json', service_json)
+
+    wrapper = Easy311::ApiWrapper.new(resource, api_key)
+
+    groups = wrapper.groups
+    groups.keys.should == ["Ordures", "Trottoirs"]
+    groups["Ordures"].should be_an_instance_of(Array)
+    groups["Ordures"][0].should be_an_instance_of(Easy311::Service)
+  end
+
+  it "returns no attrs with an empty string" do
+    resource = GetStub.new
+    attribute_json = ""
+    resource.add_response('/services/01234-1234-1234-1234.json', attribute_json)
+
+    code = "01234-1234-1234-1234"
+    wrapper = Easy311::ApiWrapper.new(resource, "1234")
+    attrs = wrapper.attrs_from_code(code)
+
+    attrs.should == []
+  end
+
+  it "returns one attribute" do
+    resource = GetStub.new
+    attribute_json = sample_attribute.to_json
+    resource.add_response('/services/01234-1234-1234-1234.json', attribute_json)
+
+    code = "01234-1234-1234-1234"
+    wrapper = Easy311::ApiWrapper.new(resource, "1234")
+    result = wrapper.attrs_from_code(code)
+
+    expect(result.length).to eq(1)
+    attribute = result[0]
+
+    expect(attribute.code).to eq("7041ac51-ec75-e211-9483-005056a613ac")
+    expect(attribute.datatype).to eq("text")
+    expect(attribute.description).to eq("Pour disposer d`appareils contenant des halocarbures (congélateur, réfrigérateur, climatiseur, etc.), veuillez communiquer avec votre bureau d'arrondissement.")
+    expect(attribute.datatype_description).to eq("Pour disposer d`appareils contenant des halocarbures (congélateur, réfrigérateur, climatiseur, etc.), veuillez communiquer avec votre bureau d'arrondissement.")
+    expect(attribute.order).to eq(2)
+    expect(attribute.required).to eq(false)
+    expect(attribute.values).to eq([])
+    expect(attribute.variable).to eq(false)
+  end
+
+  it "returns a service with an attribute" do
+    resource = GetStub.new
+    service_json = [sample_service].to_json
+    attribute_json = sample_attribute.to_json
+    resource.add_response('/services.json', [sample_service].to_json)
+    resource.add_response('/services/1934303d-7f43-e111-85e1-005056a60032.json', attribute_json)
+
+    wrapper = Easy311::ApiWrapper.new(resource, "1234")
+    services = wrapper.services_with_attrs
+    service = services[0]
+
+    expect(service.name).to eq("Collecte des encombrants - secteur résidentiel")
+    expect(service.code).to eq("1934303d-7f43-e111-85e1-005056a60032")
+    expect(service.group).to eq("Ordures")
+    expect(service.description).to eq("Description à venir")
+    expect(service.metadata).to eq(true)
+    expect(service.type).to eq("batch")
+
+    service.attrs.should be_an_instance_of(Hash)
+    attribute = service.attrs.values.first
+
+    expect(attribute.code).to eq("7041ac51-ec75-e211-9483-005056a613ac")
+    expect(attribute.datatype).to eq("text")
+    expect(attribute.description).to eq("Pour disposer d`appareils contenant des halocarbures (congélateur, réfrigérateur, climatiseur, etc.), veuillez communiquer avec votre bureau d'arrondissement.")
+    expect(attribute.datatype_description).to eq("Pour disposer d`appareils contenant des halocarbures (congélateur, réfrigérateur, climatiseur, etc.), veuillez communiquer avec votre bureau d'arrondissement.")
+    expect(attribute.order).to eq(2)
+    expect(attribute.required).to eq(false)
+    expect(attribute.values).to eq([])
+    expect(attribute.variable).to eq(false)
+  end
+
+  it "sends a request to the api" do
+    resource = PostStub.new([sample_response].to_json)
+    request = FactoryGirl.build(:easy311_request)
+
+    wrapper = Easy311::ApiWrapper.new(resource, api_key)
+    wrapper.send_request(request)
+
+    expected = {
+      'api_key' => api_key,
+      'service_code' => request.service.code,
+      'lat' => request.lat,
+      'long' => request.long,
+    }
+
+    resource.post_result.should == expected
+  end
+
+  it "sends a request with attributes to the api" do
+    resource = PostStub.new([sample_response].to_json)
+    request = FactoryGirl.build(:easy311_request)
+    request.attrs_values = {
+      '1234-1234-1234-1234' => '2345-2345-2345-2345',
+      '3456-3456-3456-3456' => '4567-4567-4567-4567'
+    }
+
+    wrapper = Easy311::ApiWrapper.new(resource, api_key)
+    wrapper.send_request(request)
+
+    expected = {
+      'api_key' => api_key,
+      'service_code' => request.service.code,
+      'lat' => request.lat,
+      'long' => request.long,
+      'attribute[1234-1234-1234-1234]' => '2345-2345-2345-2345',
+      'attribute[3456-3456-3456-3456]' => '4567-4567-4567-4567',
+    }
+
+    resource.post_result.should == expected
+  end
+
+  it "returns a response when sending a request" do
+    resource = PostStub.new([sample_response].to_json)
+    request = FactoryGirl.build(:easy311_request)
+    wrapper = Easy311::ApiWrapper.new(resource, api_key)
+
+    response = wrapper.send_request(request)
+
+    response.account_id.should be_nil
+    response.service_notice.should be_nil
+    response.service_request_id.should be_nil
+    response.token.should == "c5f0d6ad-59ca-44a4-86e8-a2d72708f54c"
+  end
+
+  it "raises an exception when api returns a 400 error" do
+    resource = ErrorStub.new([sample_response].to_json)
+    request = FactoryGirl.build(:easy311_request)
+
+    wrapper = Easy311::ApiWrapper.new(resource, api_key)
+    response = wrapper.send_request(request)
+    response.invalid?.should == true
+    response.error_message.should == "'api_key' : L'argument ne peut pas \xC3\xAAtre null ou vide."
+  end
+
+end

data/spec/easy311/json_helper.rb

@@ -0,0 +1,51 @@
+# encoding: utf-8
+def min_sample_service(opts={})
+  {
+    "service_code"=>"1934303d-7f43-e111-85e1-005056a60032",
+    "service_name"=>"Collecte des encombrants - secteur résidentiel",
+    "group"=>"Ordures",
+    "description"=>"Description à venir",
+    "metadata"=>true,
+    "type"=>"batch"
+  }.merge(opts)
+end
+
+def sample_service(opts={})
+  {
+    "description"=>"Description à venir",
+    "group"=>"Ordures",
+    "keywords"=> "Collecte,Encombrants,Gros déchets,Grosses poubelles,Grosses vidanges,Meubles,Monstres",
+    "metadata"=>true,
+    "service_code"=>"1934303d-7f43-e111-85e1-005056a60032",
+    "service_name"=>"Collecte des encombrants - secteur résidentiel",
+    "type"=>"batch"
+  }.merge(opts)
+end
+
+def sample_attribute
+  {
+     "attributes"=> [one_attribute]
+  }
+end
+
+def one_attribute(opts={})
+  {
+    "code"=>"7041ac51-ec75-e211-9483-005056a613ac",
+    "datatype"=>"text",
+    "datatype_description"=> "Pour disposer d`appareils contenant des halocarbures (congélateur, réfrigérateur, climatiseur, etc.), veuillez communiquer avec votre bureau d'arrondissement.",
+    "description"=> "Pour disposer d`appareils contenant des halocarbures (congélateur, réfrigérateur, climatiseur, etc.), veuillez communiquer avec votre bureau d'arrondissement.",
+    "order"=>2,
+    "required"=>false,
+    "values"=>[],
+    "variable"=>false
+  }.merge(opts)
+end
+
+def sample_response(opts={})
+  {
+    "account_id" => nil,
+    "service_notice" => nil,
+    "service_request_id" => nil,
+    "token" => "c5f0d6ad-59ca-44a4-86e8-a2d72708f54c"
+  }.merge(opts)
+end

data/spec/easy311/request_spec.rb

@@ -0,0 +1,114 @@
+describe Easy311::Request do
+
+  describe "responds to method missing" do
+
+    subject do
+      service = FactoryGirl.build(:easy311_service, attrs: [
+        FactoryGirl.build(:easy311_attribute, :code => "some_attribute")])
+      Easy311::Request.new(service)
+    end
+    it { should respond_to(:some_attribute) }
+    it { should respond_to(:some_attribute=) }
+    it { should_not respond_to(:invalid_attribute) }
+    it { should_not respond_to(:invalid_attribute=) }
+    it "writes Easy311 attribute values to ActiveAttr's" do
+      subject.some_attribute = 'Value 123'
+      subject.some_attribute.should == 'Value 123'
+    end
+
+    it "merges ActiveAttr and Easy311 fields when calling #attributes" do
+      subject.some_attribute = "some_value"
+      subject.attrs_values.should have_key("some_attribute")
+    end
+
+    it "has the same value in attributes" do
+      subject.some_attribute = "some_value"
+      subject.attributes["attrs"]["some_attribute"].should == "some_value"
+    end
+
+  end
+
+  describe "generates attributes to send to api_wrapper" do
+
+    it "converts lat and long" do
+      service = FactoryGirl.build(:easy311_service)
+      service.code = "1234"
+
+      request = Easy311::Request.new(service)
+      request.lat = 12.23
+      request.long = 23.34
+
+      expected = {
+        'service_code' => "1234",
+        'lat' => 12.23,
+        'long' => 23.34,
+      }
+
+      request.to_post_params.should == expected
+    end
+
+    it "converts all attributes to send to api_wrapper" do
+      service = FactoryGirl.build(:easy311_service)
+      service.code = "1234"
+
+      params = {
+        'service_code' => service.code,
+        'description' => "desc",
+        'lat' => 12.34,
+        'long' => 56.78,
+        'email' => "email@test.com",
+        'device_id' => 1,
+        'account_id' => 2,
+        'first_name' => "firstname",
+        'last_name' => "lastname",
+        'phone' => "55512345678",
+        'description' => "description",
+        'media_url' => "http://url"
+      }
+
+      request = Easy311::Request.new(service)
+      params.except('service_code').each do |key, value|
+        request.send("#{key}=", value)
+      end
+
+      request.to_post_params.should == params
+    end
+
+    it "converts question values to send to api_wrapper" do
+      service = FactoryGirl.build(:easy311_service)
+      service.code = "1234"
+
+      request = Easy311::Request.new(service)
+      request.lat = 12.34
+      request.long = 23.45
+      request.attrs_values['value1'] = "param1"
+
+      expected = {
+        'service_code' => "1234",
+        'lat' => 12.34,
+        'long' => 23.45,
+        'attribute[value1]' => "param1",
+      }
+
+      request.to_post_params.should == expected
+    end
+
+  end
+
+  describe "validations" do
+    it "responds to valid?" do
+      FactoryGirl.build(:easy311_service).should respond_to(:valid?)
+    end
+
+    it "validates required attributes" do
+      required_attr = FactoryGirl.build(:easy311_attribute, required: true)
+      service = FactoryGirl.build(:easy311_service, :attrs => [required_attr])
+
+      request = Easy311::Request.new(service)
+      request.valid?.should be_false
+      request.errors.should have_key(required_attr.code.to_sym)
+    end
+  end
+
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+require "easy311"
+require "factory_girl"
+require "easy311/factories"
+
+Easy311.logger = Logger.new('/dev/null')
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: easy311
+version: !ruby/object:Gem::Version
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors:
+- Jimmy Bourassa
+- Gregory Eric Sanderson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  name: active_attr
+  type: :runtime
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  name: rest-client
+  type: :runtime
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+description: Set of tools to ease the development of Open311 applications
+email:
+- jimmy.bourassa@hooktstudios.com
+- gzou2000@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- easy311.gemspec
+- easy311.yml
+- lib/easy311.rb
+- lib/easy311/api_wrapper.rb
+- lib/easy311/attribute.rb
+- lib/easy311/factories.rb
+- lib/easy311/rails.rb
+- lib/easy311/request.rb
+- lib/easy311/response.rb
+- lib/easy311/service.rb
+- lib/easy311/version.rb
+- spec/easy311/api_wrapper_spec.rb
+- spec/easy311/json_helper.rb
+- spec/easy311/request_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/jbourassa/easy311
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+  none: false
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+  none: false
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: ! 'Easy311 is a set of tools to ease the development of Open311 applications:
+  it provides a wrapper around the REST API and a close-to-compliant ActiveModel `Request`
+  object.'
+test_files:
+- spec/easy311/api_wrapper_spec.rb
+- spec/easy311/json_helper.rb
+- spec/easy311/request_spec.rb
+- spec/spec_helper.rb
+has_rdoc: