vestorly_api 0.0.1

data/spec/vestorly_api/default_endpiont_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+describe VestorlyApi::DefaultEndpoint do
+
+  subject { VestorlyApi::DefaultEndpoint }
+
+  describe 'default values for API' do
+    it 'gives the base url to Vestorly endpoint' do
+      subject.base_api_uri.should eq('https://vestorly-dev.herokuapp.com/')
+    end
+
+    it 'gives the base Vestory API endpoint' do
+      subject.default_api_endpoint.should eq('https://vestorly-dev.herokuapp.com/api/v1')
+    end
+
+    it 'gives the Vestorly API version' do
+      subject.api_version.should eq(1)
+    end
+  end
+end

data/spec/vestorly_api/member_spec.rb

@@ -0,0 +1,92 @@
+require 'spec_helper'
+
+
+describe VestorlyApi::Member do
+
+  def api_request_helper(requester, end_point, request_params)
+    requester.get(
+      end_point,
+      query: request_params
+    )
+  end
+
+  let(:username) { 'david@vestorly.com' }
+  let(:password) { '12desbrosses' }
+  let(:advisor_id) { 'rodas' }
+
+  let(:request_params) { {
+    username: username,
+    password: password
+  }}
+
+  let(:authentication_token) { "eyJwYXlsb2FkIjoiNTM0ZDllYmZiMDM0ZDUwMDAyMDAwNGZkIiwiY3JlYXRlZF9vbiI6MTQxMTA3OTcxMywic2lnbmF0dXJlIjoiWTdxTmpjemZkelZDV2t4bEt6djVwWlZzand1eGx0NE1DREYwODNjR2FpQT0ifQ" }
+
+  before do
+    VestorlyApi::SignIn.any_instance.stub(:sign_in).with(username, password).and_return { authentication_token }
+    VestorlyApi::SignIn.any_instance.stub(:authentication_token).and_return { authentication_token }
+    VestorlyApi::SignIn.any_instance.stub(:advisor_id).and_return { advisor_id }
+    @sign_in_api = VestorlyApi::SignIn.new(username, password)
+  end
+
+  describe 'default attributes' do
+
+    subject { described_class }
+
+    it 'should include httparty methods' do
+      subject.should include(HTTParty)
+    end
+
+  end
+
+  describe 'fetch members' do
+
+    describe 'with valid parameters' do
+
+      before do
+        VCR.insert_cassette 'fetch_members', :record => :new_episodes
+      end
+
+      after do
+        VCR.eject_cassette
+      end
+
+      it 'records the fixture' do
+        members_api = described_class.new(@sign_in_api)
+        members_api.fetch({ 'filter_by' => 'prospects' })
+      end
+
+      it 'fetch members' do
+        members_api = described_class.new(@sign_in_api)
+        fetched_members = members_api.fetch({ 'filter_by' => 'prospects' })
+        fetched_members.size.should eq(34)
+      end
+
+      it 'fetch members have requested fields' do
+        members_api = described_class.new(@sign_in_api)
+        fetched_members = members_api.fetch({ 'filter_by' => 'prospects' })
+        fetched_members[0]['_id'].should eq('53a4c1acfc4674b330000019')
+      end
+
+    end
+
+    describe 'with invalid token' do
+
+      let(:authentication_token) { "invalid" }
+
+      before do
+        VCR.insert_cassette 'invalid_fetch_members', :record => :new_episodes
+      end
+
+      after do
+        VCR.eject_cassette
+      end
+
+      it 'fetch raise exception' do
+        members_api = described_class.new(@sign_in_api)
+        expect { members_api.fetch }.to raise_error( VestorlyApi::Exceptions::Error )
+      end
+    end
+
+  end
+
+end

data/spec/vestorly_api/sign_in_spec.rb

@@ -0,0 +1,108 @@
+require 'spec_helper'
+
+describe VestorlyApi::SignIn do
+
+  def api_request_helper(requester, request_params)
+    requester.post(
+      requester.sign_in_api_endpoint,
+      query: request_params
+    )
+  end
+
+  describe 'default attributes' do
+
+    subject { described_class }
+
+    it 'should include httparty methods' do
+      subject.should include(HTTParty)
+    end
+
+    it 'should have the base url set to the VestorlyApi API endpoint' do
+      subject.sign_in_api_endpoint.should eq('https://vestorly-dev.herokuapp.com/api/v1/session_management/sign_in?version=1')
+    end
+  end
+
+  describe 'sign_in api' do
+    describe "POST sign_in" do
+
+      describe "with valid authentication" do
+
+        let(:username) { 'david@vestorly.com' }
+        let(:password) { '12desbrosses' }
+
+        let(:request_params) { {
+          username: username,
+          password: password
+        }}
+
+        subject { described_class }
+
+        before do
+          VCR.insert_cassette 'sign_in', :record => :new_episodes
+        end
+
+        after do
+          VCR.eject_cassette
+        end
+
+        it 'records the fixture' do
+          api_request_helper(subject, request_params)
+        end
+
+        it 'makes sign_in request to api returns authentication token' do
+          sign_in_api = described_class.new(username, password)
+          sign_in_api.sign_in.should eq("eyJwYXlsb2FkIjoiNTM0ZDllYmZiMDM0ZDUwMDAyMDAwNGZkIiwiY3JlYXRlZF9vbiI6MTQxMTA4Mzg0Niwic2lnbmF0dXJlIjoiVUZtcmU5REZUb0V1KzNBY2dTajdGRTJlZVJ2REl0S0Nmbm1Mbzh5cWpIVT0ifQ")
+        end
+
+        it 'assigns api response for further use' do
+          sign_in_api = described_class.new(username, password)
+          sign_in_api.sign_in
+          sign_in_api.instance_variable_get('@sign_in_response').should_not be_nil
+        end
+
+        it 'gives authentication token after sign_in' do
+          sign_in_api = described_class.new(username, password)
+          sign_in_api.sign_in
+          sign_in_api.authentication_token.should eq("eyJwYXlsb2FkIjoiNTM0ZDllYmZiMDM0ZDUwMDAyMDAwNGZkIiwiY3JlYXRlZF9vbiI6MTQxMTA4Mzg0Niwic2lnbmF0dXJlIjoiVUZtcmU5REZUb0V1KzNBY2dTajdGRTJlZVJ2REl0S0Nmbm1Mbzh5cWpIVT0ifQ")
+        end
+
+        it 'gives the advisor id' do
+          sign_in_api = described_class.new(username, password)
+          sign_in_api.sign_in
+          sign_in_api.advisor_id.should eq("rodas")
+        end
+      end
+
+      describe "with invalid authentication" do
+        let(:username) { 'invalid@example.com' }
+        let(:password) { 'nonexistingdude' }
+
+        let(:request_params) { {
+          username: username,
+          password: password
+        }}
+
+        subject { described_class }
+
+        before do
+          VCR.insert_cassette 'invalid_sign_in', :record => :new_episodes
+        end
+
+        after do
+          VCR.eject_cassette
+        end
+
+        it 'records the fixture' do
+          api_request_helper(subject, request_params)
+        end
+
+        it 'raise unauthorized sign_in error' do
+          sign_in_api = described_class.new(username, password)
+          expect { sign_in_api.sign_in }.to raise_error( VestorlyApi::Exceptions::Error )
+        end
+
+      end
+
+    end
+  end
+end

data/spec/vestorly_api/sign_out_spec.rb

@@ -0,0 +1,98 @@
+require 'spec_helper'
+
+describe VestorlyApi::SignOut do
+  def api_request_helper(requester, request_params)
+    requester.post(
+      requester.sign_out_api_endpoint,
+      query: request_params
+    )
+  end
+
+  describe 'default attributes' do
+
+    subject { described_class }
+
+    it 'should include httparty methods' do
+      subject.should include(HTTParty)
+    end
+
+    it 'should have the base url set to the VestorlyApi API endpoint' do
+      subject.sign_out_api_endpoint.should eq('https://vestorly-dev.herokuapp.com/api/v1/session_management/sign_out?version=1')
+    end
+
+  end
+
+  describe 'sign out api' do
+    describe 'POST sign out' do
+
+      describe 'with valid authentication token' do
+
+        let(:authentication_token) { "eyJwYXlsb2FkIjoiNGY2NTQyYzBjZmI0OTMwMDAxMDAwMDEzIiwiY3JlYXRlZF9vbiI6MTM5NjQ2MTg2MCwic2lnbmF0dXJlIjoiUzdYV1h6d2VaNk5vZWZialoxeGFrQmNlQjM0VktEb0s1bytRTGZOckZyST0ifQ" }
+        let(:request_params) { { "vestorly-auth" => authentication_token } }
+
+        let(:success_response) {
+          {
+            code: 202,
+            message: "Successfully logged out."
+          }
+        }
+
+        subject { described_class }
+
+        before do
+          VCR.insert_cassette 'sign_out', :record => :new_episodes
+        end
+
+        after do
+          VCR.eject_cassette
+        end
+
+        it 'records the fixture' do
+          api_request_helper(subject, request_params)
+        end
+
+        it 'makes sign out request to api returns status code ok' do
+          sign_out_api = described_class.new(authentication_token)
+          sign_out_api.sign_out.should eq(success_response)
+        end
+
+        it 'makes sign out request with class method' do
+          described_class.sign_out(authentication_token).should eq(success_response)
+        end
+
+      end
+
+      describe 'with invalid token' do
+
+        let(:authentication_token) { "invalidTokenSomething" }
+        let(:request_params) { { "vestorly-auth" => authentication_token } }
+
+        let(:error_response) {
+          {
+            code: 404,
+            message: "Not signed in."
+          }
+        }
+
+        subject { described_class }
+
+        before do
+          VCR.insert_cassette 'invalid_sign_out', :record => :new_episodes
+        end
+
+        after do
+          VCR.eject_cassette
+        end
+
+        it 'records the fixture' do
+          api_request_helper(subject, request_params)
+        end
+
+        it 'makes sign out request with class method' do
+          described_class.sign_out(authentication_token).should eq(error_response)
+        end
+
+      end
+    end
+  end
+end

data/vestorly_api.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'vestorly_api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "vestorly_api"
+  spec.version       = VestorlyApi::VERSION
+  spec.authors       = ["David Rodas"]
+  spec.email         = ["ddreliv@gmail.com"]
+  spec.summary       = %q{Vestorly API integration.}
+  spec.description   = %q{The Vestorly API provides the ability for external
+                          developers to synchronize their client data with Vestorly.
+                          The API provides support for CRM integration, content
+                          curation, client behavior monitoring, and compliance
+                          monitoring software.}
+  spec.homepage      = "https://www.vestorly.com/"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "webmock", "~>0"
+  spec.add_development_dependency "vcr", "~> 0"
+  spec.add_development_dependency "turn", "~> 0"
+  spec.add_development_dependency "rspec", "~> 0"
+
+  spec.add_runtime_dependency "httparty", "~> 0"
+end

metadata

@@ -0,0 +1,178 @@
+--- !ruby/object:Gem::Specification
+name: vestorly_api
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- David Rodas
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: turn
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |-
+  The Vestorly API provides the ability for external
+                            developers to synchronize their client data with Vestorly.
+                            The API provides support for CRM integration, content
+                            curation, client behavior monitoring, and compliance
+                            monitoring software.
+email:
+- ddreliv@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/vestorly_api.rb
+- lib/vestorly_api/advisor_base.rb
+- lib/vestorly_api/default_endpoint.rb
+- lib/vestorly_api/exceptions.rb
+- lib/vestorly_api/member.rb
+- lib/vestorly_api/response_utils.rb
+- lib/vestorly_api/sign_in.rb
+- lib/vestorly_api/sign_out.rb
+- lib/vestorly_api/version.rb
+- spec/fixtures/vestorly_api_cassettes/advisor_posts.yml
+- spec/fixtures/vestorly_api_cassettes/advisor_user_entries.yml
+- spec/fixtures/vestorly_api_cassettes/fetch_members.yml
+- spec/fixtures/vestorly_api_cassettes/invalid_fetch_members.yml
+- spec/fixtures/vestorly_api_cassettes/invalid_sign_in.yml
+- spec/fixtures/vestorly_api_cassettes/invalid_sign_out.yml
+- spec/fixtures/vestorly_api_cassettes/sign_in.yml
+- spec/fixtures/vestorly_api_cassettes/sign_out.yml
+- spec/spec_helper.rb
+- spec/vestorly_api/advisor_base_spec.rb
+- spec/vestorly_api/default_endpiont_spec.rb
+- spec/vestorly_api/member_spec.rb
+- spec/vestorly_api/sign_in_spec.rb
+- spec/vestorly_api/sign_out_spec.rb
+- vestorly_api.gemspec
+homepage: https://www.vestorly.com/
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Vestorly API integration.
+test_files:
+- spec/fixtures/vestorly_api_cassettes/advisor_posts.yml
+- spec/fixtures/vestorly_api_cassettes/advisor_user_entries.yml
+- spec/fixtures/vestorly_api_cassettes/fetch_members.yml
+- spec/fixtures/vestorly_api_cassettes/invalid_fetch_members.yml
+- spec/fixtures/vestorly_api_cassettes/invalid_sign_in.yml
+- spec/fixtures/vestorly_api_cassettes/invalid_sign_out.yml
+- spec/fixtures/vestorly_api_cassettes/sign_in.yml
+- spec/fixtures/vestorly_api_cassettes/sign_out.yml
+- spec/spec_helper.rb
+- spec/vestorly_api/advisor_base_spec.rb
+- spec/vestorly_api/default_endpiont_spec.rb
+- spec/vestorly_api/member_spec.rb
+- spec/vestorly_api/sign_in_spec.rb
+- spec/vestorly_api/sign_out_spec.rb
+has_rdoc: