passaporteweb-client 0.0.10 → 0.0.11

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    passaporteweb-client (0.0.10)
+    passaporteweb-client (0.0.11)
       multi_json (~> 1.7.1)
       rest-client (~> 1.6.7)
 

data/README.rdoc

@@ -40,11 +40,11 @@ Or install it yourself as:
 * {Autenticação de usuários}[https://app.passaporteweb.com.br/static/docs/usuarios.html#autenticacao-de-usuarios]
   * {GET /accounts/api/auth/}[https://app.passaporteweb.com.br/static/docs/usuarios.html#get-accounts-api-auth] ==> PassaporteWeb::Identity.authenticate or PassaporteWeb::Identity#authenticate
 * {Notificações}[https://app.passaporteweb.com.br/static/docs/notificacao.html]
-  * {GET /notifications/api/}[https://app.passaporteweb.com.br/static/docs/notificacao.html#get-notifications-api] ==> (not implemented yet)
-  * {POST /notifications/api/}[https://app.passaporteweb.com.br/static/docs/notificacao.html#post-notifications-api] ==> (not implemented yet)
-  * {GET /notifications/api/count/}[https://app.passaporteweb.com.br/static/docs/notificacao.html#get-notifications-api-count] ==> (not implemented yet)
-  * {PUT /notifications/api/:uuid/}[https://app.passaporteweb.com.br/static/docs/notificacao.html#put-notifications-api-uuid] ==> (not implemented yet)
-  * {DELETE /notifications/api/:uuid/}[https://app.passaporteweb.com.br/static/docs/notificacao.html#delete-notifications-api-uuid] ==> (not implemented yet)
+  * {GET /notifications/api/}[https://app.passaporteweb.com.br/static/docs/notificacao.html#get-notifications-api] ==> PassaporteWeb::Notification.find_all
+  * {POST /notifications/api/}[https://app.passaporteweb.com.br/static/docs/notificacao.html#post-notifications-api] ==> PassaporteWeb::Notification#save
+  * {GET /notifications/api/count/}[https://app.passaporteweb.com.br/static/docs/notificacao.html#get-notifications-api-count] ==> PassaporteWeb::Notification.count
+  * {PUT /notifications/api/:uuid/}[https://app.passaporteweb.com.br/static/docs/notificacao.html#put-notifications-api-uuid] ==> PassaporteWeb::Notification#save
+  * {DELETE /notifications/api/:uuid/}[https://app.passaporteweb.com.br/static/docs/notificacao.html#delete-notifications-api-uuid] ==> PassaporteWeb::Notification#destroy
 * {Gerência de contas}[https://app.passaporteweb.com.br/static/docs/account_manager.html]
   * {PUT /organizations/api/activate/}[https://app.passaporteweb.com.br/static/docs/account_manager.html#put-organizations-api-activate] ==> (not implemented yet)
   * {GET /organizations/api/accounts/}[https://app.passaporteweb.com.br/static/docs/account_manager.html#get-organizations-api-accounts] ==> PassaporteWeb::ServiceAccount.find_all

data/lib/passaporte_web.rb

@@ -12,6 +12,7 @@ require "passaporte_web/identity"
 require "passaporte_web/service_account"
 require "passaporte_web/service_account_member"
 require "passaporte_web/identity_service_account"
+require "passaporte_web/notification"
 
 module PassaporteWeb
 

data/lib/passaporte_web/notification.rb

@@ -0,0 +1,184 @@
+# encoding: utf-8
+module PassaporteWeb
+
+  # Represents the Notifications of PassaporteWeb.
+  class Notification
+    include Attributable
+
+    ATTRIBUTES = [:body, :target_url, :uuid, :absolute_url, :scheduled_to, :sender_data, :read_at, :notification_type, :destination]
+    CREATABLE_ATTRIBUTES = [:body, :target_url, :scheduled_to, :destination]
+    UPDATEABLE_ATTRIBUTES = []
+
+    attr_accessor *(CREATABLE_ATTRIBUTES + UPDATEABLE_ATTRIBUTES)
+    attr_reader *(ATTRIBUTES - (CREATABLE_ATTRIBUTES + UPDATEABLE_ATTRIBUTES))
+    attr_reader :errors
+
+    # Finds all Notifications destined to the authenticated user, paginated. By default returns 20 notifications
+    # per request, starting at "page" 1. Returns an OpenStruct object with two attributes <tt>notifications</tt>
+    # and <tt>meta</tt>. <tt>notifications</tt> is an array of Notification instances or an empty array
+    # if no Notifications are found. <tt>meta</tt> is an OpenStruct object with information about limit and available
+    # pagination values, to use in subsequent calls to <tt>.find_all</tt>. Raises a <tt>RestClient::ResourceNotFound</tt>
+    # exception if the requested page does not exist. All method parameters are optional.
+    #
+    # API method: <tt>GET /notifications/api/</tt>
+    #
+    # API documentation: https://app.passaporteweb.com.br/static/docs/notificacao.html#get-notifications-api
+    #
+    # Example:
+    #   data = PassaporteWeb::Notification.find_all
+    #   data.notifications # => [notification1, notification2, ...]
+    #   data.meta # => #<OpenStruct limit=20, next_page=2, prev_page=nil, first_page=1, last_page=123>
+    #   data.meta.limit      # => 20
+    #   data.meta.next_page  # => 2
+    #   data.meta.prev_page  # => nil
+    #   data.meta.first_page # => 1
+    #   data.meta.last_page  # => 123
+    def self.find_all(page=1, limit=20, since=nil, show_read=false, ordering="oldest-first")
+      since = since.strftime('%Y-%m-%d') if since && since.respond_to?(:strftime)
+      params = {
+        page: page, limit: limit, since: since, show_read: show_read, ordering: ordering
+      }.reject { |k,v| v.nil? || v.to_s.empty? }
+      response = Http.get("/notifications/api/", params, 'user')
+      raw_data = MultiJson.decode(response.body)
+      result_hash = {}
+      result_hash[:notifications] = raw_data.map { |hash| load_notification(hash) }
+      result_hash[:meta] = PassaporteWeb::Helpers.meta_links_from_header(response.headers[:link])
+      PassaporteWeb::Helpers.convert_to_ostruct_recursive(result_hash)
+    rescue *[RestClient::BadRequest] => e
+      MultiJson.decode(e.response.body)
+    end
+
+    # Returns the number of notifications available for the authenticated user. All parameters
+    # are optional.
+    #
+    # API method: <tt>GET /notifications/api/count/</tt>
+    #
+    # API documentation: https://app.passaporteweb.com.br/static/docs/notificacao.html#get-notifications-api-count
+    def self.count(show_read=false, since=nil)
+      since = since.strftime('%Y-%m-%d') if since && since.respond_to?(:strftime)
+      params = {
+        since: since, show_read: show_read
+      }.reject { |k,v| v.nil? || v.to_s.empty? }
+      response = Http.get("/notifications/api/count/", params, 'user')
+      data = MultiJson.decode(response.body)
+      Integer(data['count'])
+    rescue *[RestClient::BadRequest] => e
+      MultiJson.decode(e.response.body)
+    end
+
+    # Instanciates a new Notification with the supplied attributes.
+    #
+    # Example:
+    #
+    #   notification = PassaporteWeb::Notification.new(
+    #     destination: "ac3540c7-5453-424d-bdfd-8ef2d9ff78df",
+    #     body: "Feliz ano novo!",
+    #     target_url: "https://app.passaporteweb.com.br",
+    #     scheduled_to: "2012-01-01 00:00:00"
+    #   )
+    # TOSPEC
+    def initialize(attributes={})
+      set_attributes(attributes)
+      @errors = {}
+    end
+
+    # TODOC
+    #
+    # API methods:
+    # * <tt>POST /notifications/api/</tt> (on create)
+    # * <tt>PUT /notifications/api/:uuid/</tt> (on update)
+    #
+    # API documentation:
+    # * https://app.passaporteweb.com.br/static/docs/notificacao.html#post-notifications-api
+    # * https://app.passaporteweb.com.br/static/docs/notificacao.html#put-notifications-api-uuid
+    # TOSPEC
+    # TOSPEC
+    def save(auth_type='user')
+      self.persisted? ? update : create(auth_type)
+    end
+
+    # TODOC
+    #
+    # API method: <tt>DELETE /notifications/api/:uuid/</tt>
+    #
+    # API documentation: https://app.passaporteweb.com.br/static/docs/notificacao.html#delete-notifications-api-uuid
+    # TOSPEC
+    def destroy
+      return false unless self.persisted?
+      response = Http.delete('/notifications/api/:uuid/')
+      raise "unexpected response: #{response.code} - #{response.body}" unless response.code == 204
+      @errors = {}
+      @persisted = false
+      @destroyed = true
+      true
+    end
+
+    # Returns a hash with all attribures of the Notification.
+    def attributes
+      ATTRIBUTES.inject({}) do |hash, attribute|
+        hash[attribute] = self.send(attribute)
+        hash
+      end
+    end
+
+    def persisted?
+      @persisted == true && !self.uuid.nil?
+    end
+
+    def destroyed?
+      @destroyed == true
+    end
+
+    private
+
+    def create(auth_type)
+      # TODO validar atributos?
+      response = Http.post(
+        '/notifications/api/',
+        create_body,
+        {},
+        auth_type
+      )
+      raise "unexpected response: #{response.code} - #{response.body}" unless response.code == 201
+      attributes_hash = MultiJson.decode(response.body)
+      set_attributes(attributes_hash)
+      @persisted = true
+      @errors = {}
+      true
+    rescue *[RestClient::BadRequest] => e
+      @persisted = false
+      @errors = MultiJson.decode(e.response.body)
+      false
+    end
+
+    def update
+      # TODO validar atributos?
+      response = Http.put(
+        "/notifications/api/#{self.uuid}/",
+        {},
+        {},
+        'user'
+      )
+      raise "unexpected response: #{response.code} - #{response.body}" unless response.code == 200
+      attributes_hash = MultiJson.decode(response.body)
+      set_attributes(attributes_hash)
+      @errors = {}
+      true
+    rescue *[RestClient::BadRequest] => e
+      @errors = MultiJson.decode(e.response.body)
+      false
+    end
+
+    def create_body
+      self.attributes.select { |key, value| CREATABLE_ATTRIBUTES.include?(key) && (!value.nil? && !value.to_s.empty?) }
+    end
+
+    def self.load_notification(attributes)
+      notification = self.new(attributes)
+      notification.instance_variable_set(:@persisted, true)
+      notification
+    end
+
+  end
+
+end

data/lib/passaporte_web/version.rb

@@ -1,4 +1,4 @@
 # encoding: utf-8
 module PassaporteWeb
-  VERSION = "0.0.10"
+  VERSION = "0.0.11"
 end

data/passaporteweb-client.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.name          = "passaporteweb-client"
   spec.version       = PassaporteWeb::VERSION
   spec.authors       = ["Rodrigo Tassinari de Oliveira", "Rodrigo Martins"]
-  spec.email         = ["rodrigo@pittlandia.net", "rodrigo.tassinari@myfreecomm.com.br", "rodrigo.martins@myfreecomm.com.br", "rodrigo@rrmartins.com"]
+  spec.email         = ["rodrigo@pittlandia.net", "rodrigo.tassinari@myfreecomm.com.br", "rodrigo@rrmartins.com", "rodrigo.martins@myfreecomm.com.br"]
   spec.description   = %q{A Ruby client for the PassaporteWeb REST API}
   spec.summary       = %q{A Ruby client for the PassaporteWeb REST API: https://app.passaporteweb.com.br/static/docs/}
   spec.homepage      = "https://github.com/myfreecomm/passaporteweb-client-ruby"

data/spec/passaporte_web/notification_spec.rb

@@ -0,0 +1,193 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe PassaporteWeb::Notification do
+
+  describe "constants" do
+    it { PassaporteWeb::Notification::ATTRIBUTES.should == [:body, :target_url, :uuid, :absolute_url, :scheduled_to, :sender_data, :read_at, :notification_type, :destination] }
+    it { PassaporteWeb::Notification::CREATABLE_ATTRIBUTES.should == [:body, :target_url, :scheduled_to, :destination] }
+  end
+
+  describe ".new" do
+    it "should instanciate an empty object" do
+      notification = PassaporteWeb::Notification.new
+      notification.should_not be_persisted
+      notification.attributes.should == {:body=>nil, :target_url=>nil, :uuid=>nil, :absolute_url=>nil, :scheduled_to=>nil, :sender_data=>nil, :read_at=>nil, :notification_type=>nil, :destination=>nil}
+      notification.uuid.should be_nil
+      notification.destination.should be_nil
+      notification.body.should be_nil
+      notification.target_url.should be_nil
+      notification.scheduled_to.should be_nil
+      notification.absolute_url.should be_nil
+      notification.sender_data.should be_nil
+      notification.read_at.should be_nil
+      notification.notification_type.should be_nil
+    end
+    it "should instanciate an object with attributes set" do
+      attributes = {
+        "destination" => "ac3540c7-5453-424d-bdfd-8ef2d9ff78df",
+        "body" => "Feliz ano novo!",
+        "target_url" => "https://app.passaporteweb.com.br",
+        "scheduled_to" => "2012-01-01 00:00:00"
+      }
+      notification = PassaporteWeb::Notification.new(attributes)
+      notification.should_not be_persisted
+      notification.uuid.should be_nil
+      notification.attributes.should == {:body=>"Feliz ano novo!", :target_url=>"https://app.passaporteweb.com.br", :uuid=>nil, :absolute_url=>nil, :scheduled_to=>"2012-01-01 00:00:00", :sender_data=>nil, :read_at=>nil, :notification_type=>nil, :destination=>"ac3540c7-5453-424d-bdfd-8ef2d9ff78df"}
+      notification.destination.should == "ac3540c7-5453-424d-bdfd-8ef2d9ff78df"
+      notification.body.should == "Feliz ano novo!"
+      notification.target_url.should == "https://app.passaporteweb.com.br"
+      notification.scheduled_to.should == "2012-01-01 00:00:00"
+      notification.absolute_url.should be_nil
+      notification.sender_data.should be_nil
+      notification.read_at.should be_nil
+      notification.notification_type.should be_nil
+    end
+  end
+
+  describe ".find_all", :vcr => true do
+    before(:each) do
+      PassaporteWeb.configuration.user_token = "f01d30c0a2e878fecc838735560253f9e9395932f5337f40"
+    end
+    context "on success" do
+      it "should return the first 20 notifications for the authenticated user, along with pagination information" do
+        data = PassaporteWeb::Notification.find_all
+
+        notifications = data.notifications
+        notifications.size.should == 2
+        notifications.map { |n| n.instance_of?(described_class) }.uniq.should be_true
+        n1, n2 = notifications
+        n1.body.should == '"oioioi"' # TODO why? was it created like this?
+        n2.body.should == '"oioioisss"'
+        n1.uuid.should == "2ca046be-0178-418d-80ac-3a334c264009"
+        n2.uuid.should == "11f40530-2de0-471d-b1f7-ff39ea21363f"
+
+        meta = data.meta
+        meta.limit.should == 20
+        meta.next_page.should == nil
+        meta.prev_page.should == nil
+        meta.first_page.should == 1
+        meta.last_page.should == 1
+      end
+      it "should return notifications for the authenticated user according to params, along with pagination information" do
+        data = PassaporteWeb::Notification.find_all(2, 1, nil, true, "newest-first")
+
+        notifications = data.notifications
+        notifications.size.should == 1
+        notifications.map { |n| n.instance_of?(described_class) }.uniq.should be_true
+        n1 = notifications.first
+        n1.body.should == '"oioioi"' # TODO why? was it created like this?
+        n1.uuid.should == "2ca046be-0178-418d-80ac-3a334c264009"
+
+        meta = data.meta
+        meta.limit.should == 1
+        meta.next_page.should == nil
+        meta.prev_page.should == 1
+        meta.first_page.should == 1
+        meta.last_page.should == 2
+      end
+    end
+    context "on failure" do
+      it "400 Bad Request" do
+        PassaporteWeb::Notification.find_all(1, 20, nil, true, 'lalala').should == {"ordering"=>["Faça uma escolha válida. lalala não está disponível."]}
+      end
+      it "404 Not Found" do
+        expect {
+          PassaporteWeb::Notification.find_all(1_000_000)
+        }.to raise_error(RestClient::ResourceNotFound, '404 Resource Not Found')
+      end
+    end
+  end
+
+  describe ".count", :vcr => true do
+    before(:each) do
+      PassaporteWeb.configuration.user_token = "f01d30c0a2e878fecc838735560253f9e9395932f5337f40"
+    end
+    context "on success" do
+      it "should return count of notifications for the authenticated user" do
+        PassaporteWeb::Notification.count.should == 2
+      end
+      it "should return count of notifications for the authenticated user, according to params" do
+        PassaporteWeb::Notification.count(true, '2013-04-02').should == 2
+      end
+    end
+    context "on failure" do
+      it "it should return an error message if an invalid parameter is sent" do
+        PassaporteWeb::Notification.count(false, "lalala").should == {"since"=>["Informe uma data/hora válida."]}
+      end
+    end
+  end
+
+  describe "#save", vcr: true do
+    context "on create" do
+      let(:notification) { described_class.new(body: 'feliz aniversário!', target_url: 'http://pittlandia.net', scheduled_to: '2013-04-19 10:50:19', destination: 'a5868d14-6529-477a-9c6b-a09dd42a7cd2') }
+      context "on success" do
+        it "should create the Notification on PassaporteWeb, authenticated as the user" do
+          PassaporteWeb.configuration.user_token = "f01d30c0a2e878fecc838735560253f9e9395932f5337f40"
+          notification.should_not be_persisted
+          notification.save.should be_true # by default authenticates as the user
+          notification.should be_persisted
+          notification.uuid.should_not be_nil
+          notification.absolute_url.should_not be_nil
+          notification.destination.should be_nil # FIXME is this right? shouldn't it be a5868d14-6529-477a-9c6b-a09dd42a7cd2 ???
+          notification.scheduled_to.should == '2013-04-19 00:00:00' # FIXME is this right? shouldn't it be 2013-04-19 10:50:19 ???
+          notification.body.should == 'feliz aniversário!'
+          notification.target_url.should == 'http://pittlandia.net/' # PW added the trailing slash, WTF?
+          notification.sender_data.should == {"name" => "Rodrigo Martins", "uuid" => "385f5f3c-8d33-4b95-9e0d-e87962985244"}
+          notification.read_at.should be_nil
+          notification.notification_type.should be_nil
+        end
+        it "should create the Notification on PassaporteWeb, authenticated as the application" do
+          notification.should_not be_persisted
+          notification.save('application').should be_true
+          notification.should be_persisted
+          notification.uuid.should_not be_nil
+          notification.absolute_url.should_not be_nil
+          notification.destination.should be_nil # FIXME is this right? shouldn't it be a5868d14-6529-477a-9c6b-a09dd42a7cd2 ???
+          notification.scheduled_to.should == '2013-04-19 00:00:00' # FIXME is this right? shouldn't it be 2013-04-19 10:50:19 ???
+          notification.body.should == 'feliz aniversário!'
+          notification.target_url.should == 'http://pittlandia.net/' # PW added the trailing slash, WTF?
+          notification.sender_data.should == {"name" => "Identity Client", "slug" => "identity_client"}
+          notification.read_at.should be_nil
+          notification.notification_type.should be_nil
+        end
+      end
+      context "on failure" do
+        it "should return false and set the errors with the reason for the failure, authenticated as the user" do
+          PassaporteWeb.configuration.user_token = "f01d30c0a2e878fecc838735560253f9e9395932f5337f40"
+          notification.target_url = 'lalalala'
+          notification.should_not be_persisted
+          notification.save('user').should be_false
+          notification.should_not be_persisted
+          notification.uuid.should be_nil
+          notification.errors.should == {"field_errors"=>{"target_url"=>["Informe uma URL válida."]}}
+        end
+        it "should return false and set the errors with the reason for the failure, authenticated as the application" do
+          notification.destination = nil # required field
+          notification.should_not be_persisted
+          notification.save('application').should be_false
+          notification.should_not be_persisted
+          notification.uuid.should be_nil
+          notification.errors.should == {"field_errors"=>{"destination"=>["Este campo é obrigatório."]}}
+        end
+      end
+    end
+    context "on update" do
+      let(:notification) { described_class.find_all.notifications.last }
+      before(:each) do
+        PassaporteWeb.configuration.user_token = "f01d30c0a2e878fecc838735560253f9e9395932f5337f40"
+      end
+      context "on success" do
+        it "should mark the Notification as read" do
+          notification.read_at.should be_nil
+          notification.save
+          notification.read_at.should_not be_nil
+        end
+      end
+      context "on failure" do
+        it "should return false and set the errors with the reason for the failure"
+      end
+    end
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: passaporteweb-client
 version: !ruby/object:Gem::Version
-  version: 0.0.10
+  version: 0.0.11
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-03 00:00:00.000000000 Z
+date: 2013-04-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -224,8 +224,8 @@ description: A Ruby client for the PassaporteWeb REST API
 email:
 - rodrigo@pittlandia.net
 - rodrigo.tassinari@myfreecomm.com.br
-- rodrigo.martins@myfreecomm.com.br
 - rodrigo@rrmartins.com
+- rodrigo.martins@myfreecomm.com.br
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -246,6 +246,7 @@ files:
 - lib/passaporte_web/http.rb
 - lib/passaporte_web/identity.rb
 - lib/passaporte_web/identity_service_account.rb
+- lib/passaporte_web/notification.rb
 - lib/passaporte_web/service_account.rb
 - lib/passaporte_web/service_account_member.rb
 - lib/passaporte_web/version.rb
@@ -255,6 +256,7 @@ files:
 - spec/passaporte_web/http_spec.rb
 - spec/passaporte_web/identity_service_account_spec.rb
 - spec/passaporte_web/identity_spec.rb
+- spec/passaporte_web/notification_spec.rb
 - spec/passaporte_web/service_account_member_spec.rb
 - spec/passaporte_web/service_account_spec.rb
 - spec/passaporte_web_spec.rb
@@ -274,7 +276,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3548297114629816547
+      hash: 2546346199843108538
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -283,7 +285,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3548297114629816547
+      hash: 2546346199843108538
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25
@@ -296,6 +298,7 @@ test_files:
 - spec/passaporte_web/http_spec.rb
 - spec/passaporte_web/identity_service_account_spec.rb
 - spec/passaporte_web/identity_spec.rb
+- spec/passaporte_web/notification_spec.rb
 - spec/passaporte_web/service_account_member_spec.rb
 - spec/passaporte_web/service_account_spec.rb
 - spec/passaporte_web_spec.rb