nexaas_id-client 0.5.0

data/lib/nexaas_id/client/oauth.rb

@@ -0,0 +1,20 @@
+require 'oauth2'
+
+# OAuth2 client used by NexaasID::Client::Application and NexaasID::Client::Identity.
+# Provides direct access to the underlying OAuth2 API.
+class NexaasID::Client::OAuth
+
+  def self.build
+    config = NexaasID.configuration
+    OAuth2::Client.new(config.application_token,
+                       config.application_secret,
+                       site: config.url,
+                       connection_opts: { headers: headers })
+  end
+
+  private
+
+  def self.headers
+    { 'Accept': 'application/json', 'Content-type': 'application/json' }
+  end
+end

data/lib/nexaas_id/client.rb

@@ -0,0 +1,2 @@
+module NexaasID::Client
+end

data/lib/nexaas_id/configuration.rb

@@ -0,0 +1,13 @@
+class NexaasID::Configuration
+
+  attr_accessor :url, :user_agent, :application_token, :application_secret
+
+  def initialize
+    @url = 'https://id.nexaas.com'
+    @user_agent = "Nexaas ID Ruby Client v#{NexaasID::VERSION}"
+  end
+
+  def url_for(path)
+    %(#{url.chomp('/')}#{path})
+  end
+end

data/lib/nexaas_id/entities/base.rb

@@ -0,0 +1,5 @@
+require "virtus"
+
+class NexaasID::Entities::Base
+  include Virtus.model
+end

data/lib/nexaas_id/entities/collection.rb

@@ -0,0 +1,53 @@
+class NexaasID::Entities::Collection < Base
+  extend Forwardable
+
+  PAGE_REGEX = /page=(\d+)/
+
+  attr_reader :total
+  def_delegators :@collection, :first, :last, :each, :map, :count, :empty?, :any?
+
+  def initialize(response, entity_class)
+    @response = response
+    @entity_class = entity_class
+    @total = parsed_body['count'].to_i
+    @collection = []
+   end
+
+  def self.build(response, entity_class)
+    self.new(response, entity_class).build
+  end
+
+  def build
+    build_collection
+    self
+  end
+
+  def next_page
+    page_for('next')
+  end
+
+  def previous_page
+    page_for('previous')
+  end
+
+  def to_a
+    @collection.clone
+  end
+
+  private
+
+  def page_for(page_rel)
+    match = parsed_body[page_rel].match(PAGE_REGEX)
+    return match[1].to_i if match
+  end
+
+  def build_collection
+    parsed_body['collection'].each do |attributes|
+      @collection.push(@entity_class.new(attributes))
+    end
+  end
+
+  def parsed_body
+    @parsed_body ||= @response.parsed
+  end
+end

data/lib/nexaas_id/entities/profile/contacts.rb

@@ -0,0 +1,4 @@
+class NexaasID::Entities::Profile::Contacts < NexaasID::Entities::Base
+  attribute :id,            Integer
+  attribute :phone_numbers, Array[String]
+end

data/lib/nexaas_id/entities/profile/emails.rb

@@ -0,0 +1,4 @@
+class NexaasID::Entities::Profile::Emails < NexaasID::Entities::Base
+  attribute :id,      Integer
+  attribute :emails,  Array[String]
+end

data/lib/nexaas_id/entities/profile/professional_info.rb

@@ -0,0 +1,6 @@
+class NexaasID::Entities::Profile::ProfessionalInfo < NexaasID::Entities::Base
+  attribute :id,          Integer
+  attribute :profession,  String
+  attribute :company,     String
+  attribute :position,    String
+end

data/lib/nexaas_id/entities/profile.rb

@@ -0,0 +1,14 @@
+class NexaasID::Entities::Profile < NexaasID::Entities::Base
+  attribute :id,        Integer
+  attribute :name,      String
+  attribute :nickname,  String
+  attribute :email,     String
+  attribute :birth,     Date
+  attribute :gender,    String
+  attribute :language,  String
+  attribute :picture,   String
+  attribute :timezone,  String
+  attribute :country,   String
+  attribute :city,      String
+  attribute :bio,       String
+end

data/lib/nexaas_id/entities/sign_up.rb

@@ -0,0 +1,5 @@
+class NexaasID::Entities::SignUp < NexaasID::Entities::Base
+  attribute :id,        String
+  attribute :email,     String
+  attribute :requester, String
+end

data/lib/nexaas_id/entities.rb

@@ -0,0 +1,2 @@
+module NexaasID::Entities
+end

data/lib/nexaas_id/resources/base.rb

@@ -0,0 +1,34 @@
+# Default root for all resource classes.
+class NexaasID::Resources::Base
+  # Creates an instance of this class.
+  #
+  # @param [api] api An instance of OAuth2::AccessToken
+  def initialize(api)
+    @api = api
+  end
+
+  protected
+
+  attr_reader :api
+
+  # Builds an entity from the OAuth2 response.
+  #
+  # @param [OAuth2::Response] response The response from any OAuth2::AccessToken method
+  # @param [NexaasID::Entities::Base] naked_klass The class which the response will be
+  #   deserialized into (must be a subtype of NexaasID::Entities::Base).
+  #   Optional if the entity name is the same as the resource name.
+  #
+  # @return [NexaasID::Entities::Base] an instance of naked_class
+  def respond_with_entity(response, naked_klass = entity_klass)
+    # response.parsed is a Hash
+    naked_klass.new(response.parsed)
+  end
+
+  def base_klass
+    @base_klass ||= self.class.name.split("::").last
+  end
+
+  def entity_klass
+    @entity_klass ||= NexaasID::Entities.const_get(base_klass.to_sym)
+  end
+end

data/lib/nexaas_id/resources/profile.rb

@@ -0,0 +1,67 @@
+# A wrapper to Nexaas ID's profile API
+#
+# [API]
+#   Documentation:
+#
+# @example Getting the user's profile:
+#   client = NexaasID::Client::Identity.new(credentials)
+#   client.profile.get
+#
+# @example Getting the user's list of emails:
+#   client = NexaasID::Client::Identity.new(credentials)
+#   client.profile.emails
+#
+# @see NexaasID::Client::Identity#initialize
+class NexaasID::Resources::Profile < NexaasID::Resources::Base
+
+  # Retrieves the user's profile
+  #
+  # [API]
+  #   Method: <tt>GET /api/v1/profile</tt>
+  #
+  #   Documentation:
+  #
+  # @return [NexaasID::Entities::Profile] user's profile
+  def get
+    respond_with_entity(api.get('/api/v1/profile'))
+  end
+
+  # Retrieves the user's professional info
+  #
+  # [API]
+  #   Method: <tt>GET /api/v1/profile/professional_info</tt>
+  #
+  #   Documentation:
+  #
+  # @return [NexaasID::Entities::Profile::ProfessionalInfo] user's professional info
+  def professional_info
+    respond_with_entity(api.get('/api/v1/profile/professional_info'),
+                        NexaasID::Entities::Profile::ProfessionalInfo)
+  end
+
+  # Retrieves the user's contacts
+  #
+  # [API]
+  #   Method: <tt>GET /api/v1/profile/contacts</tt>
+  #
+  #   Documentation:
+  #
+  # @return [NexaasID::Entities::Profile::Contacts] user's contacts
+  def contacts
+    respond_with_entity(api.get('/api/v1/profile/contacts'),
+                        NexaasID::Entities::Profile::Contacts)
+  end
+
+  # Retrieves the user's emails
+  #
+  # [API]
+  #   Method: <tt>GET /api/v1/profile/emails</tt>
+  #
+  #   Documentation:
+  #
+  # @return [NexaasID::Entities::Profile::Emails] user's emails
+  def emails
+    respond_with_entity(api.get('/api/v1/profile/emails'),
+                        NexaasID::Entities::Profile::Emails)
+  end
+end

data/lib/nexaas_id/resources/sign_up.rb

@@ -0,0 +1,30 @@
+# A wrapper to Nexaas ID's sign up API
+#
+# [API]
+#   Documentation:
+#
+# @example Inviting a new user to Nexaas ID (on behalf of an existing user):
+#   client = NexaasID::Client::Identity.new(credentials)
+#   client.sign_up.create('john.doe@gmail.com')
+#
+# @example Inviting a new user to Nexaas ID (on behalf of an application):
+#   client = NexaasID::Client::Application.new
+#   client.sign_up.create('john.doe@gmail.com')
+#
+# @see NexaasID::Client::Identity#initialize
+# @see NexaasID::Client::Application#initialize
+class NexaasID::Resources::SignUp < NexaasID::Resources::Base
+
+  # Invites an user to Nexaas ID, by creating a new sign up.
+  #
+  # [API]
+  #   Method: <tt>POST /api/v1/sign_up</tt>
+  #
+  #   Documentation:
+  # @param [String] email The new user's email.
+  #
+  # @return [NexaasID::Entities::SignUp] the new sign up; it contains the invited user's id.
+  def create(email)
+    respond_with_entity(api.post('/api/v1/sign_up', body: MultiJson.dump({ invited: email })))
+  end
+end

data/lib/nexaas_id/resources/widget.rb

@@ -0,0 +1,28 @@
+# A wrapper to Nexaas ID's widget API
+#
+# [API]
+#   Documentation:
+#
+# @example Obtaining the user's navbar URL:
+#   client = NexaasID::Client::Identity.new(credentials)
+#   client.widget.navbar_url
+#
+# @example Inviting a new user to Nexaas ID (on behalf of an application):
+#   client = NexaasID::Client::Application.new
+#   client.sign_up.create('john.doe@gmail.com')
+#
+# @see NexaasID::Client::Identity#initialize
+class NexaasID::Resources::Widget < NexaasID::Resources::Base
+
+  # Retrieves the user's navbar URL
+  #
+  # [API]
+  #   Method: <tt>GET /api/v1/widgets/navbar</tt>
+  #
+  #   Documentation:
+  #
+  # @return [String] user's navbar URL
+  def navbar_url
+    %(#{NexaasID.configuration.url}/api/v1/widgets/navbar?access_token=#{api.token})
+  end
+end

data/lib/nexaas_id/resources.rb

@@ -0,0 +1,2 @@
+module NexaasID::Resources
+end

data/lib/nexaas_id/version.rb

@@ -0,0 +1,4 @@
+# encoding: utf-8
+module NexaasID
+  VERSION = "0.5.0".freeze
+end

data/lib/nexaas_id.rb

@@ -0,0 +1,40 @@
+# encoding: utf-8
+
+require 'oauth2'
+require 'multi_json'
+
+require "nexaas_id/version"
+require "nexaas_id/configuration"
+
+require "nexaas_id/client"
+require "nexaas_id/client/application"
+require "nexaas_id/client/exception"
+require "nexaas_id/client/exception_wrapper"
+require "nexaas_id/client/identity"
+require "nexaas_id/client/oauth"
+
+require "nexaas_id/entities"
+require "nexaas_id/entities/base"
+
+require "nexaas_id/entities/profile"
+require "nexaas_id/entities/profile/professional_info"
+require "nexaas_id/entities/profile/contacts"
+require "nexaas_id/entities/profile/emails"
+
+require "nexaas_id/entities/sign_up"
+
+require "nexaas_id/resources"
+require "nexaas_id/resources/base"
+require "nexaas_id/resources/profile"
+require "nexaas_id/resources/sign_up"
+require "nexaas_id/resources/widget"
+
+module NexaasID
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+    yield(configuration) if block_given?
+  end
+end

data/nexaas_id-client.gemspec

@@ -0,0 +1,43 @@
+# 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','nexaas_id','version.rb'])
+
+Gem::Specification.new do |spec|
+  spec.name          = "nexaas_id-client"
+  spec.version       = NexaasID::VERSION
+  spec.authors       = ["Rodrigo Tassinari de Oliveira", "Eduardo Hertz", "Rafael B. Tauil", "Luiz Carlos Buiatte"]
+  spec.email         = ["rodrigo@pittlandia.net", "rodrigo.tassinari@myfreecomm.com.br", "eduardo.hertz@myfreecomm.com.br", "rafael@tauil.com.br", "luiz.buiatte@nexaas.com"]
+  spec.description   = %q{A Ruby client for the Nexaas ID REST API}
+  spec.summary       = %q{A Ruby client for the Nexaas ID REST API: https://id.nexaas.com/static/docs/}
+  spec.homepage      = "https://github.com/myfreecomm/nexaas-id-client-ruby"
+  spec.license       = "Apache-2.0"
+  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 "multi_json", "~> 1.11"
+  spec.add_dependency "virtus", "~> 1.0"
+  spec.add_dependency "oauth2", "~> 1.4.0"
+
+  spec.add_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "rake", "~> 12.0"
+  spec.add_development_dependency "rdoc", "~> 6.0"
+  spec.add_development_dependency "rspec", "~> 3.6"
+  spec.add_development_dependency "vcr", "~> 2.4"
+  spec.add_development_dependency 'webmock', '~> 3.4'
+  spec.add_development_dependency "pry-byebug", "~> 3.4"
+  spec.add_development_dependency "awesome_print", "~> 1.8"
+  spec.add_development_dependency "simplecov", "~> 0.14"
+  spec.add_development_dependency "coveralls", "~> 0.8"
+  spec.add_development_dependency "json", "~> 2.1"
+  spec.add_development_dependency "faraday-cookie_jar", "~> 0.0.6"
+  spec.add_development_dependency "dotenv", "~> 2.5.0"
+end

data/spec/nexaas_id/client/application_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe NexaasID::Client::Application do
+  subject { described_class.new }
+
+  describe '#sign_up' do
+    it 'provides the signup resource' do
+      VCR.use_cassette('application/sign_up/client_credentials') do
+        expect(subject.sign_up).to be_a(NexaasID::Resources::SignUp)
+      end
+    end
+  end
+end

data/spec/nexaas_id/client/exception_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe NexaasID::Client::Exception do
+  subject { described_class.new('foobar', response) }
+
+  let(:headers) { { 'Content-Type' => 'application/json' } }
+  let(:body) { { text: 'Coffee brewing failed' }.to_json }
+  let(:response) do
+    OAuth2::Response.new(double('response', status: 418, headers: headers, body: body))
+  end
+
+  it { expect(subject.status).to eq(418) }
+  it { expect(subject.headers).to eq(headers) }
+  it { expect(subject.body).to eq(body) }
+end

data/spec/nexaas_id/client/exception_wrapper_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+
+describe NexaasID::Client::ExceptionWrapper do
+  let(:token) { instance_double('OAuth::AccessToken') }
+  subject { described_class.new(token) }
+
+  let(:oauth2_error) { OAuth2::Error.new(response) }
+  let(:faraday_error) { Faraday::ClientError.new(Faraday::Error::ConnectionFailed.new('timeout')) }
+  let(:headers) { { 'Content-Type' => 'application/json' } }
+  let(:body) { { text: 'Coffee brewing failed' }.to_json }
+  let(:response) do
+    OAuth2::Response.new(double('response', status: 418, headers: headers, body: body))
+  end
+
+  describe '#request' do
+    it 'delegates to token' do
+      expect(token).to receive(:request).with(:get, '/api/v1/profile')
+      subject.request(:get, '/api/v1/profile')
+    end
+
+    it 'should raise an exception for Faraday::ClientError' do
+      expect(token).to receive(:request).with(:get, '/api/v1/profile').and_raise(faraday_error)
+      expect { subject.request(:get, '/api/v1/profile') }.to raise_error(NexaasID::Client::Exception)
+    end
+
+    it 'should raise an exception for Faraday::ClientError' do
+      expect(token).to receive(:request).with(:get, '/api/v1/profile').and_raise(oauth2_error)
+      expect { subject.request(:get, '/api/v1/profile') }.to raise_error(NexaasID::Client::Exception)
+    end
+  end
+
+  describe '#refresh' do
+    it 'delegates to token' do
+      expect(token).to receive(:refresh).with(a: :b)
+      subject.refresh(a: :b)
+    end
+
+    it 'should raise an exception for Faraday::ClientError' do
+      expect(token).to receive(:refresh).with(a: :b).and_raise(faraday_error)
+      expect { subject.refresh(a: :b) }.to raise_error(NexaasID::Client::Exception)
+    end
+
+    it 'should raise an exception for Faraday::ClientError' do
+      expect(token).to receive(:refresh).with(a: :b).and_raise(oauth2_error)
+      expect { subject.refresh(a: :b) }.to raise_error(NexaasID::Client::Exception)
+    end
+  end
+end

data/spec/nexaas_id/client/identity_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+describe NexaasID::Client::Identity do
+  subject { described_class.new(user_credentials) }
+
+  describe '#profile' do
+    it 'provides the profile resource' do
+      VCR.use_cassette('identity/refresh_token') do
+        expect(subject.profile).to be_a(NexaasID::Resources::Profile)
+      end
+    end
+  end
+
+  describe '#sign_up' do
+    it 'provides the signup resource' do
+      VCR.use_cassette('identity/refresh_token') do
+        expect(subject.sign_up).to be_a(NexaasID::Resources::SignUp)
+      end
+    end
+  end
+
+  describe '#sign_up' do
+    it 'provides the widget resource' do
+      VCR.use_cassette('identity/refresh_token') do
+        expect(subject.widget).to be_a(NexaasID::Resources::Widget)
+      end
+    end
+  end
+end

data/spec/nexaas_id/configuration_spec.rb

@@ -0,0 +1,38 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe NexaasID::Configuration do
+
+  it "should use the production Nexaas ID URL by default" do
+    expect(NexaasID::Configuration.new.url).to eq('https://id.nexaas.com')
+  end
+
+  it "should use a default user agent" do
+    expect(NexaasID::Configuration.new.user_agent).to eq("Nexaas ID Ruby Client v#{NexaasID::VERSION}")
+  end
+
+  it 'should allow setting the configuration parameters' do
+    config = NexaasID::Configuration.new
+
+    config.url = 'https://sandbox.id.nexaas.com'
+    config.application_token = '58ca7acc-9479-4671-8b7c-745c5a65ce08'
+    config.application_secret = '8da0d1a5-961d-461f-8ae6-1922db172340'
+
+    expect(config.url).to eq('https://sandbox.id.nexaas.com')
+    expect(config.application_token).to eq('58ca7acc-9479-4671-8b7c-745c5a65ce08')
+    expect(config.application_secret).to eq('8da0d1a5-961d-461f-8ae6-1922db172340')
+  end
+
+  describe '#url_for' do
+    let(:configuration) { described_class.new }
+
+    it 'generates an URL to a resource' do
+      expect(configuration.url_for('/api/v1/profile')).to eq('https://id.nexaas.com/api/v1/profile')
+
+      configuration.url = 'https://sandbox.id.nexaas.com/'
+      expect(configuration.url_for('/api/v1/profile'))
+        .to eq('https://sandbox.id.nexaas.com/api/v1/profile')
+    end
+  end
+
+end

data/spec/nexaas_id/resources/profile_spec.rb

@@ -0,0 +1,54 @@
+require 'spec_helper'
+
+describe NexaasID::Resources::Profile do
+  let(:client) { NexaasID::Client::Identity.new(user_credentials) }
+  let(:resource) { client.profile }
+
+  describe "#get" do
+    subject { resource.get }
+
+    it 'returns the profile for the user' do
+      VCR.use_cassette('identity/profile/profile/success') do
+        expect(subject).to be_a(NexaasID::Entities::Profile)
+        expect(subject.id).to eq('57bb5938-d0c5-439a-9986-e5c565124beb')
+        expect(subject.email).to eq('luiz.buiatte+pw.api.test@nexaas.com')
+      end
+    end
+  end
+
+  describe '#profession_info' do
+    subject { resource.professional_info }
+
+    it 'returns the professional info for the user' do
+      VCR.use_cassette('identity/profile/professional_info/success') do
+        expect(subject).to be_a(NexaasID::Entities::Profile::ProfessionalInfo)
+        expect(subject.id).to eq('57bb5938-d0c5-439a-9986-e5c565124beb')
+        expect(subject.company).to eq('Nexaas')
+      end
+    end
+  end
+
+  describe '#contacts' do
+    subject { resource.contacts }
+
+    it 'returns the contacts for the user' do
+      VCR.use_cassette('identity/profile/contacts/success') do
+        expect(subject).to be_a(NexaasID::Entities::Profile::Contacts)
+        expect(subject.id).to eq('57bb5938-d0c5-439a-9986-e5c565124beb')
+        expect(subject.phone_numbers).not_to be_empty
+      end
+    end
+  end
+
+  describe '#contacts' do
+    subject { resource.emails }
+
+    it 'returns the contacts for the user' do
+      VCR.use_cassette('identity/profile/emails/success') do
+        expect(subject).to be_a(NexaasID::Entities::Profile::Emails)
+        expect(subject.id).to eq('57bb5938-d0c5-439a-9986-e5c565124beb')
+        expect(subject.emails).not_to be_empty
+      end
+    end
+  end
+end

data/spec/nexaas_id/resources/sign_up_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+describe NexaasID::Resources::SignUp do
+  let(:resource) { client.sign_up }
+
+  describe "#create" do
+    describe 'with application client' do
+      let(:client) { NexaasID::Client::Application.new }
+      subject { resource.create('demurtas@mailinator.com') }
+
+      it 'invites an user' do
+        VCR.use_cassette('application/sign_up/create/success') do
+          expect(subject.id).not_to be_nil
+          expect(subject.email).to eq('demurtas@mailinator.com')
+          expect(subject.requester).to be_nil
+        end
+      end
+    end
+
+    describe 'with identity client' do
+      let(:client) { NexaasID::Client::Identity.new(user_credentials) }
+      subject { resource.create('demurtas@mailinator.com') }
+
+      it 'invites an user' do
+        VCR.use_cassette('identity/sign_up/create/success') do
+          expect(subject.id).not_to be_nil
+          expect(subject.email).to eq('demurtas@mailinator.com')
+          expect(subject.requester).not_to be_nil
+        end
+      end
+    end
+  end
+end

data/spec/nexaas_id/resources/widget_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+describe NexaasID::Resources::Widget do
+  let(:client) { NexaasID::Client::Identity.new(user_credentials) }
+  let(:resource) { client.widget }
+
+  describe "#navbar_url" do
+    subject { resource.navbar_url }
+    let(:regexp) { %r(#{Regexp.quote(NexaasID.configuration.url)}/api/v1/widgets/navbar\?access_token=(.+?)$) }
+
+    it 'returns the navbar url for this user' do
+      VCR.use_cassette('identity/widget/navbar_url/success') do
+        expect(subject).to match(regexp)
+        expect(Faraday.get(subject).status).to eq(200)
+      end
+    end
+  end
+end