passaporteweb-client 0.0.10

data/lib/passaporte_web/service_account.rb

@@ -0,0 +1,118 @@
+# encoding: utf-8
+module PassaporteWeb
+
+  # Represents a ServiceAccount on PassaporteWeb, which is the 'account' of an Identity within a Service. A
+  # Service may have many ServiceAccount s and many Identity ies via it's ServiceAccount s. A Identity may
+  # belong to serveral Service s via it's ServiceAccount s.
+  class ServiceAccount
+    include Attributable
+
+    ATTRIBUTES = [:plan_slug, :expiration, :identity, :roles, :member_uuid, :role, :include_expired_accounts, :name, :members_data, :url, :service_data, :account_data, :add_member_url]
+    UPDATABLE_ATTRIBUTES = [:plan_slug, :expiration]
+
+    attr_accessor *UPDATABLE_ATTRIBUTES
+    attr_reader *(ATTRIBUTES - UPDATABLE_ATTRIBUTES)
+    attr_reader :errors
+
+    def initialize(attributes={})
+      set_attributes(attributes)
+      @errors = {}
+    end
+
+    def uuid
+      self.account_data['uuid'] if self.account_data
+    end
+
+    # Finds all ServiceAccounts that the current authenticated application has access to, paginated. By default finds
+    # 20 ServiceAccounts per request, starting at "page" 1. Returns an OpenStruct object with two attributes
+    # <tt>service_accounts</tt> and <tt>meta</tt>. <tt>service_accounts</tt> is an array of ServiceAccount instances or an empty array
+    # if no ServiceAccounts 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.
+    #
+    # API method: <tt>GET /organizations/api/accounts/</tt>
+    #
+    # API documentation: https://app.passaporteweb.com.br/static/docs/account_manager.html#get-organizations-api-accounts
+    #
+    # Example:
+    #   data = PassaporteWeb::ServiceAccount.find_all
+    #   data.service_accounts # => [account1, account2, ...]
+    #   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)
+      response = Http.get("/organizations/api/accounts/?page=#{Integer(page)}&limit=#{Integer(limit)}")
+      raw_accounts = MultiJson.decode(response.body)
+      result_hash = {}
+      result_hash[:service_accounts] = raw_accounts.map { |raw_account| load_service_account(raw_account) }
+      result_hash[:meta] = PassaporteWeb::Helpers.meta_links_from_header(response.headers[:link])
+      PassaporteWeb::Helpers.convert_to_ostruct_recursive(result_hash)
+    end
+
+    # Instanciates an ServiceAccount identified by it's UUID, with all the details. Only service accounts related to the current
+    # authenticated application are available. Returns the ServiceAccount instance if successful, or raises a
+    # <tt>RestClient::ResourceNotFound</tt> exception if no ServiceAccount exists with that UUID (or if it is not
+    # related to the current authenticated application).
+    #
+    # API method: <tt>GET /organizations/api/accounts/:uuid/</tt>
+    #
+    # API documentation: https://app.passaporteweb.com.br/static/docs/account_manager.html#get-organizations-api-accounts-uuid
+    def self.find(uuid)
+      response = Http.get("/organizations/api/accounts/#{uuid}/")
+      attributes_hash = MultiJson.decode(response.body)
+      load_service_account(attributes_hash)
+    end
+
+    # Updates an existing ServiceAccount, changing it's plan_slug and/or expiration date. Returns true
+    # if successfull or false if not. In case of failure, it will fill the <tt>errors</tt> attribute
+    # with the reason for the failure to save the object.
+    #
+    # API method: <tt>PUT /organizations/api/accounts/:uuid/</tt>
+    #
+    # API documentation: https://app.passaporteweb.com.br/static/docs/account_manager.html#put-organizations-api-accounts-uuid
+    def save
+      # TODO validar atributos?
+      response = update
+      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::Conflict, RestClient::BadRequest] => e
+      @errors = MultiJson.decode(e.response.body)
+      false
+    end
+
+    def attributes
+      ATTRIBUTES.inject({}) do |hash, attribute|
+        hash[attribute] = self.send(attribute)
+        hash
+      end
+    end
+
+    def persisted?
+      @persisted == true
+    end
+
+    private
+
+    def update
+      Http.put("/organizations/api/accounts/#{self.uuid}/", update_body)
+    end
+
+    def update_body
+      self.attributes.select { |key, value| UPDATABLE_ATTRIBUTES.include?(key) && !value.nil? }
+    end
+
+    def self.load_service_account(attributes_hash)
+      service_account = self.new(attributes_hash)
+      service_account.instance_variable_set(:@persisted, true)
+      service_account
+    end
+
+  end
+
+end

data/lib/passaporte_web/service_account_member.rb

@@ -0,0 +1,136 @@
+# encoding: utf-8
+module PassaporteWeb
+
+  # Represents the membership of an Identity within a ServiceAccount on PassaporteWeb.
+  class ServiceAccountMember
+
+    attr_accessor :roles
+    attr_reader :service_account, :identity
+    attr_reader :errors
+
+    # Instanciates a new ServiceAccountMember to represent the membership of the supplied Identity in
+    # the supplied ServiceAccount. The <tt>roles</tt> attribute should be an array of strings. Any
+    # value is accepted, only 'owner' is reserved. By default uses only the value of 'user'.
+    def initialize(service_account, identity, roles=['user'])
+      @service_account = service_account
+      @identity = identity
+      @roles = roles
+      @membership_details_url = nil
+      @errors = {}
+    end
+
+    # Finds the membership relation between the supplied Identity in the supplied ServiceAccount and returns
+    # an instance of ServiceAccountMember representing it.
+    #
+    # Raises a <tt>RestClient::ResourceNotFound</tt> exception if the supplied Identity does not have a
+    # membership within the supplied ServiceAccount, or if any of the supplied objects is invalid or
+    # not existent.
+    #
+    # API method: <tt>GET /organizations/api/accounts/:uuid/members/:member_uuid/</tt>
+    #
+    # API documentation: https://app.passaporteweb.com.br/static/docs/account_manager.html#get-organizations-api-accounts-uuid-members-member-uuid
+    def self.find(service_account, identity)
+      response = Http.get("/organizations/api/accounts/#{service_account.uuid}/members/#{identity.uuid}/")
+      raise "unexpected response: #{response.code} - #{response.body}" unless response.code == 200
+      attributes_hash = MultiJson.decode(response.body)
+      member = self.new(service_account, identity, attributes_hash['roles'])
+      member.instance_variable_set(:@persisted, true)
+      member.instance_variable_set(:@destroyed, false)
+      member
+    end
+
+    # Returns true if the ServiceAccountMember was loaded from PassaporteWeb or saved there successfully.
+    def persisted?
+      @persisted == true
+    end
+
+    # Returns true if the ServiceAccountMember object has been destroyed (and thus represents a membership
+    # no more valid on PassaporteWeb)
+    def destroyed?
+      @destroyed == true
+    end
+
+    def membership_details_url # :nodoc:
+      return @membership_details_url if @membership_details_url
+      "/organizations/api/accounts/#{self.service_account.uuid}/members/#{self.identity.uuid}/" if persisted?
+    end
+
+    # Creates or updates the ServiceAccountMember object on PassaporteWeb. Returns true if successful and false
+    # (along with the reason for failure in the #errors method) otherwise.
+    #
+    # On update, the only attribute that can be changed is the <tt>roles</tt>. This can be set to anything,
+    # including 'owner', on update (on create, the 'owner' role is not allowed.)
+    #
+    # API methods:
+    # * <tt>POST /organizations/api/accounts/:uuid/members/</tt> (on create)
+    # * <tt>PUT /organizations/api/accounts/:uuid/members/:member_uuid/</tt> (on update)
+    #
+    # API documentation:
+    # * https://app.passaporteweb.com.br/static/docs/account_manager.html#post-organizations-api-accounts-uuid-members
+    # * https://app.passaporteweb.com.br/static/docs/account_manager.html#put-organizations-api-accounts-uuid-members-member-uuid
+    def save
+      self.persisted? ? update : create
+    end
+
+    # Destroys the membership relation between a Identity and a ServiceAccount, e.g. the Identity no longer will be a
+    # member of the ServiceAccount. Returns true if successful of false (along with the reason for failure in the #errors
+    # method) otherwise.
+    #
+    # If the member has a 'owner' role, than the membership can not be destroyed.
+    #
+    # API method: <tt>DELETE /organizations/api/accounts/:uuid/members/:member_uuid/</tt>
+    #
+    # API documentation: https://app.passaporteweb.com.br/static/docs/account_manager.html#delete-organizations-api-accounts-uuid-members-member-uuid
+    def destroy
+      return false unless self.persisted?
+      response = Http.delete(self.membership_details_url)
+      raise "unexpected response: #{response.code} - #{response.body}" unless response.code == 204
+      @errors = {}
+      @persisted = false
+      @destroyed = true
+      true
+    rescue *[RestClient::NotAcceptable] => e
+      @errors = MultiJson.decode(e.response.body)
+      @persisted = true
+      @destroyed = false
+      false
+    end
+
+    private
+
+    def create
+      response = Http.post(
+        "/organizations/api/accounts/#{self.service_account.uuid}/members/",
+        {identity: self.identity.uuid, roles: self.roles}
+      )
+      raise "unexpected response: #{response.code} - #{response.body}" unless response.code == 200 # doc says 201
+      attributes_hash = MultiJson.decode(response.body)
+      @membership_details_url = attributes_hash['membership_details_url']
+      @errors = {}
+      @persisted = true
+      true
+    rescue *[RestClient::Conflict, RestClient::BadRequest, RestClient::NotAcceptable] => e
+      @errors = MultiJson.decode(e.response.body)
+      @persisted = false
+      false
+    end
+
+    def update
+      response = Http.put(
+        self.membership_details_url,
+        {roles: self.roles}
+      )
+      raise "unexpected response: #{response.code} - #{response.body}" unless response.code == 200
+      attributes_hash = MultiJson.decode(response.body)
+      @errors = {}
+      @persisted = true
+      true
+    rescue *[RestClient::BadRequest, RestClient::NotAcceptable] => e
+      @errors = MultiJson.decode(e.response.body)
+      @persisted = true
+      false
+    end
+
+  end
+
+end

data/lib/passaporte_web/version.rb

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

data/passaporteweb-client.gemspec

@@ -0,0 +1,40 @@
+# encoding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+# Ensure we require the local version and not one we might have installed already
+require File.join([File.dirname(__FILE__),'lib','passaporte_web','version.rb'])
+
+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.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"
+  spec.license       = "Apache-v2"
+  spec.has_rdoc      = true
+
+  # VCR cassettes are too long for the gemspec, see http://stackoverflow.com/questions/14371686/building-rails-3-engine-throwing-gempackagetoolongfilename-error
+  # spec.files         = `git ls-files`.split($/)
+  spec.files         = `git ls-files`.split($/).reject { |f| f =~ %r{(vcr_cassettes)/} }
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rest-client", "~> 1.6.7"
+  spec.add_dependency "multi_json", "~> 1.7.1"
+
+  spec.add_development_dependency "bundler", "~> 1.3.2"
+  spec.add_development_dependency "rake", "~> 10.0.4"
+  spec.add_development_dependency 'rdoc', '~> 4.0.1'
+  spec.add_development_dependency "rspec", "~> 2.13.0"
+  spec.add_development_dependency "vcr", "~> 2.4.0"
+  spec.add_development_dependency "webmock", "~> 1.9.3"
+  spec.add_development_dependency "pry", "~> 0.9.12"
+  spec.add_development_dependency "pry-nav", "~> 0.2.3"
+  spec.add_development_dependency "awesome_print", "~> 1.1.0"
+  spec.add_development_dependency "simplecov", "~> 0.7.1"
+  spec.add_development_dependency "coveralls", "~> 0.6.3"
+end

data/spec/passaporte_web/configuration_spec.rb

@@ -0,0 +1,55 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe PassaporteWeb::Configuration do
+
+  it "should use the production PassaporteWeb URL by default" do
+    PassaporteWeb::Configuration.new.url.should == 'https://app.passaporteweb.com.br'
+  end
+
+  it "should use a default user agent" do
+    PassaporteWeb::Configuration.new.user_agent.should == "PassaporteWeb Ruby Client v#{PassaporteWeb::VERSION}"
+  end
+
+  it 'should allow setting the configuration parameters' do
+    config = PassaporteWeb::Configuration.new
+
+    config.url = 'http://sandbox.app.passaporteweb.com.br'
+    config.application_token = 'some-app-token'
+    config.application_secret = 'some-app-secret'
+
+    config.url.should == 'http://sandbox.app.passaporteweb.com.br'
+    config.application_token.should == 'some-app-token'
+    config.application_secret.should == 'some-app-secret'
+    config.user_token.should be_nil
+  end
+
+  describe "#application_credentials" do
+    let(:config) { PassaporteWeb::Configuration.new }
+    it "should return the HTTP Basic Auth header value for the application login" do
+      config.application_token = 'some-app-token'
+      config.application_secret = 'some-app-secret'
+      config.application_credentials.should == 'Basic c29tZS1hcHAtdG9rZW46c29tZS1hcHAtc2VjcmV0'
+    end
+    it "should require the application_token to be set" do
+      config.application_secret = 'some-app-secret'
+      expect { config.application_credentials }.to raise_error(ArgumentError, 'application_token not set')
+    end
+    it "should require the application_secret to be set" do
+      config.application_token = 'some-app-token'
+      expect { config.application_credentials }.to raise_error(ArgumentError, 'application_secret not set')
+    end
+  end
+
+  describe "#user_credentials" do
+    let(:config) { PassaporteWeb::Configuration.new }
+    it "should return the HTTP Basic Auth header value for the user login" do
+      config.user_token = 'some-user-token'
+      config.user_credentials.should == 'Basic OnNvbWUtdXNlci10b2tlbg=='
+    end
+    it "should require the user_token to be set" do
+      expect { config.user_credentials }.to raise_error(ArgumentError, 'user_token not set')
+    end
+  end
+
+end

data/spec/passaporte_web/helpers_spec.rb

@@ -0,0 +1,34 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe PassaporteWeb::Helpers do
+
+  describe ".meta_links_from_header" do
+    it "should return a hash from the link header string" do
+      link_header = "<http://sandbox.app.passaporteweb.com.br/organizations/api/accounts/?page=3&limit=3>; rel=next, <http://sandbox.app.passaporteweb.com.br/organizations/api/accounts/?page=1&limit=3>; rel=prev, <http://sandbox.app.passaporteweb.com.br/organizations/api/accounts/?page=123&limit=3>; rel=last, <http://sandbox.app.passaporteweb.com.br/organizations/api/accounts/?page=1&limit=3>; rel=first"
+      described_class.meta_links_from_header(link_header).should == {
+        limit: 3,
+        next_page: 3,
+        prev_page: 1,
+        first_page: 1,
+        last_page: 123
+      }
+    end
+  end
+
+  describe ".convert_to_ostruct_recursive" do
+    it "should convert a hash recursevely to a OpenStruct" do
+      hash = {a: 1, b: {c: 3, d: 4, e: {f: 6, g: 7}}}
+      os = described_class.convert_to_ostruct_recursive(hash)
+      os.should be_instance_of(OpenStruct)
+      os.a.should == 1
+      os.b.should be_instance_of(OpenStruct)
+      os.b.c.should == 3
+      os.b.d.should == 4
+      os.b.e.should be_instance_of(OpenStruct)
+      os.b.e.f.should == 6
+      os.b.e.g.should == 7
+    end
+  end
+
+end

data/spec/passaporte_web/http_spec.rb

@@ -0,0 +1,114 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe PassaporteWeb::Http do
+
+  before(:each) do
+    PassaporteWeb.configure do |c|
+      c.url = 'https://some/where'
+      c.user_agent = 'My Mocking App v1.1'
+      c.application_token = 'some-app-token'
+      c.application_secret = 'some-app-secret'
+      c.user_token = 'some-user-token'
+    end
+  end
+
+  let(:mock_response) { mock('restclient http response') }
+
+  describe ".get" do
+    it "should use RestClient.get with the supplied params and common options" do
+      RestClient.should_receive(:get).with(
+        'https://some/where/foo',
+        params: {spam: 'eggs'},
+        authorization: 'Basic c29tZS1hcHAtdG9rZW46c29tZS1hcHAtc2VjcmV0',
+        content_type: :json,
+        accept: :json,
+        user_agent: 'My Mocking App v1.1'
+      ).and_return(mock_response)
+      described_class.get('/foo', spam: 'eggs')
+    end
+  end
+
+  describe ".custom_auth_get" do
+    it "should use RestClient.get with the supplied params and common options, but with the custom authorization" do
+      RestClient.should_receive(:get).with(
+        'https://some/where/foo',
+        params: {spam: 'eggs'},
+        authorization: 'Basic am9obkBkb2UuY29tOnRoZWJpcmRpc3RoZXdvcmQ=',
+        content_type: :json,
+        accept: :json,
+        user_agent: 'My Mocking App v1.1'
+      ).and_return(mock_response)
+      described_class.custom_auth_get('john@doe.com', 'thebirdistheword', '/foo', spam: 'eggs')
+    end
+  end
+
+  describe ".delete" do
+    it "should use RestClient.delete with the supplied params and common options" do
+      RestClient.should_receive(:delete).with(
+        'https://some/where/foo',
+        params: {spam: 'eggs'},
+        authorization: 'Basic c29tZS1hcHAtdG9rZW46c29tZS1hcHAtc2VjcmV0',
+        content_type: :json,
+        accept: :json,
+        user_agent: 'My Mocking App v1.1'
+      ).and_return(mock_response)
+      described_class.delete('/foo', spam: 'eggs')
+    end
+  end
+
+  describe ".put" do
+    it "should use RestClient.get with the supplied params and common options, encoding body as json" do
+      RestClient.should_receive(:put).with(
+        'https://some/where/foo',
+        '{"hello":"world"}',
+        params: {spam: 'eggs'},
+        authorization: 'Basic c29tZS1hcHAtdG9rZW46c29tZS1hcHAtc2VjcmV0',
+        content_type: :json,
+        accept: :json,
+        user_agent: 'My Mocking App v1.1'
+      ).and_return(mock_response)
+      described_class.put('/foo', {hello: 'world'}, {spam: 'eggs'})
+    end
+    it "should use RestClient.get with the supplied params and common options, with body already as json" do
+      RestClient.should_receive(:put).with(
+        'https://some/where/foo',
+        '{"hello":"world"}',
+        params: {spam: 'eggs'},
+        authorization: 'Basic c29tZS1hcHAtdG9rZW46c29tZS1hcHAtc2VjcmV0',
+        content_type: :json,
+        accept: :json,
+        user_agent: 'My Mocking App v1.1'
+      ).and_return(mock_response)
+      described_class.put('/foo', '{"hello":"world"}', {spam: 'eggs'})
+    end
+  end
+
+  describe ".post" do
+    it "should use RestClient.post with the supplied params and common options, encoding body as json" do
+      RestClient.should_receive(:post).with(
+        'https://some/where/foo',
+        '{"hello":"world"}',
+        params: {},
+        authorization: 'Basic c29tZS1hcHAtdG9rZW46c29tZS1hcHAtc2VjcmV0',
+        content_type: :json,
+        accept: :json,
+        user_agent: 'My Mocking App v1.1'
+      ).and_return(mock_response)
+      described_class.post('/foo', {hello: 'world'})
+    end
+    it "should use RestClient.post with the supplied params and common options, with body already as json" do
+      RestClient.should_receive(:post).with(
+        'https://some/where/foo',
+        '{"hello":"world"}',
+        params: {},
+        authorization: 'Basic c29tZS1hcHAtdG9rZW46c29tZS1hcHAtc2VjcmV0',
+        content_type: :json,
+        accept: :json,
+        user_agent: 'My Mocking App v1.1'
+      ).and_return(mock_response)
+      described_class.post('/foo', '{"hello":"world"}')
+    end
+  end
+
+end