plangrade-ruby 0.2.0 → 0.3.0

data/spec/oauth2_client_spec.rb

@@ -0,0 +1,109 @@
+# -*- encoding: utf-8 -*-
+
+# Copyright (c) Microsoft Corporation
+# All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# THIS CODE IS PROVIDED *AS IS* BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
+# ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION ANY
+# IMPLIED WARRANTIES OR CONDITIONS OF TITLE, FITNESS FOR A PARTICULAR
+# PURPOSE, MERCHANTABLITY OR NON-INFRINGEMENT.
+#
+# See the Apache Version 2.0 License for specific language governing
+# permissions and limitations under the License.
+
+require File.expand_path('../spec_helper', __FILE__)
+
+describe Plangrade::OAuth2Client do
+
+  subject do
+    Plangrade::OAuth2Client.new('PRbTcg9qjgKsp4jjpm1pw', 'a2nQpcUm2Dgq1chWdAvbXGTk', {
+      :connection_options => {
+        :headers => {
+          'User-Agent' => "Plangrade OAuth2 Client #{Plangrade::Ruby::VERSION}",
+          "Accept"     => "application/json"
+        }
+      }
+    })
+  end
+
+  describe "#webserver_authorization_url" do
+    it "returns the authorization url" do
+      params = {
+        "client_id" => "PRbTcg9qjgKsp4jjpm1pw",
+        "redirect_uri" => "https://localhost:3000/callback",
+        "response_type" =>"code",
+        "state" => "12345"
+      }
+
+      auth_url = subject.webserver_authorization_url(
+        :client_id => 'PRbTcg9qjgKsp4jjpm1pw',
+        :state => '12345',
+        :redirect_uri => 'https://localhost:3000/callback'
+      )
+
+      parsed_url = Addressable::URI.parse(auth_url)
+      expect(parsed_url.path).to eq '/oauth/authorize'
+      expect(parsed_url.query_values).to eq params
+      expect(parsed_url.scheme).to eq 'https'
+      expect(parsed_url.host).to eq 'plangrade.com'
+    end
+  end
+
+  describe "#exchange_auth_code_for_token" do
+    it "makes a POST request to exchange authorization code for access token" do
+
+      stub_request(:post, "https://plangrade.com/oauth/token").with(
+        :body => {
+          :grant_type    => 'authorization_code',
+          :code          => 'MmOGL795LbIZuJJVnL49Cc',
+          :redirect_uri  => 'http://localhost:3000/callback',
+          :client_id     => 'PRbTcg9qjgKsp4jjpm1pw',
+          :client_secret => 'a2nQpcUm2Dgq1chWdAvbXGTk'
+        },
+        :headers => {
+          'Accept'         =>'application/json',
+          'Content-Type'   =>'application/x-www-form-urlencoded', 
+          'User-Agent'     =>"Plangrade OAuth2 Client #{Plangrade::Ruby::VERSION}"
+      })
+
+      subject.exchange_auth_code_for_token(
+        :params => {
+          :code => 'MmOGL795LbIZuJJVnL49Cc',
+          :redirect_uri => 'http://localhost:3000/callback'
+        }
+      )
+    end
+  end
+
+  describe "#refresh_access_token" do
+    it "makes a POST request to exchange a refresh token for access token" do
+
+      stub_request(:post, "https://plangrade.com/oauth/token").with(
+        :body => {
+          :grant_type    => 'refresh_token',
+          :refresh_token => 'MmOGL795LbIZuJJVnL49Cc',
+          :redirect_uri  => 'http://localhost:3000/callback',
+          :client_id     => 'PRbTcg9qjgKsp4jjpm1pw',
+          :client_secret => 'a2nQpcUm2Dgq1chWdAvbXGTk'
+        },
+        :headers => {
+          'Accept'         =>'application/json',
+          'Content-Type'   =>'application/x-www-form-urlencoded', 
+          'User-Agent'     =>"Plangrade OAuth2 Client #{Plangrade::Ruby::VERSION}"
+      })
+
+      subject.refresh_access_token(
+        :params => {
+          :refresh_token => 'MmOGL795LbIZuJJVnL49Cc',
+          :redirect_uri => 'http://localhost:3000/callback'
+        }
+      )
+    end
+  end
+end

data/spec/resources/base_spec.rb

@@ -0,0 +1,190 @@
+# -*- encoding: utf-8 -*-
+
+# Copyright (c) Microsoft Corporation
+# All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# THIS CODE IS PROVIDED *AS IS* BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
+# ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION ANY
+# IMPLIED WARRANTIES OR CONDITIONS OF TITLE, FITNESS FOR A PARTICULAR
+# PURPOSE, MERCHANTABLITY OR NON-INFRINGEMENT.
+#
+# See the Apache Version 2.0 License for specific language governing
+# permissions and limitations under the License.
+
+require File.expand_path('../../spec_helper', __FILE__)
+
+describe Plangrade::Resources::Base do
+
+  class DummyModel < Plangrade::Resources::Base
+    attr_accessor_deffered :name, :email
+  end
+
+  class Plangrade::Client
+    def update_dummy_model(id, opts={})
+      put("/api/v1/dummy_models/#{id}", opts)
+    end
+  end
+
+  before :all do
+    Plangrade.configure do |conf|
+      conf.access_token = 'TolNOFka9Uls2DxahNi78A'
+    end
+  end
+
+  after :all do
+    Plangrade.reset!
+  end
+
+  context 'new user object with id' do
+
+    subject { DummyModel.new(:id => 42) }
+
+    describe "#id" do
+      it 'should be 42' do
+        expect(subject.id).to eq 42
+      end
+    end
+
+    describe "#id=" do
+      it 'sets id' do
+        subject.send(:"id=", 2)
+        expect(subject.id).to eq 2
+      end
+    end
+
+    describe "#new_record?" do
+      it 'returns false' do
+        expect(subject.new_record?).to eq false
+      end
+    end
+
+    describe "#modified?" do
+
+      context 'new model and no changes' do
+        it 'returns false' do
+          model =  DummyModel.new(:name => 'jim', :email => 'compliance@plangrade.com')
+          expect(model.modified?).to eq false
+        end
+      end
+
+      context 'new model and no changes' do
+        it 'returns false' do
+          model =  DummyModel.new(:name => 'mary', :email => 'support@plangrade.com')
+          model.name = 'jim'
+          model.email = 'compliance@plangrade.com'
+          expect(model.modified?).to eq false
+        end
+      end
+
+      context 'persisted model and no changes' do
+        it 'returns true' do
+          model =  DummyModel.new(:id => 12, :name => 'jim', :email => 'compliance@plangrade.com')
+          expect(model.modified?).to eq false
+        end
+      end
+
+      context 'persisted model and changes' do
+        it 'returns true' do
+          model =  DummyModel.new(:id => 42, :name => 'jim', :email => 'compliance@plangrade.com')
+          model.name = 'smithy'
+          expect(model.modified?).to eq true
+        end
+      end
+    end
+
+    describe "#changes" do
+      it 'returns empty hash' do
+        expect(subject.changes).to eq({})
+      end
+    end
+
+    describe "#save" do
+      it 'returns true' do
+        stub_request(:put, "https://plangrade.com/api/v1/dummy_models/42").with(
+          :body => {"name"=>"smithy"},
+          :headers => {
+            'Accept'       =>'application/json',
+            'Authorization'=>'Bearer TolNOFka9Uls2DxahNi78A',
+            'Content-Type' =>'application/x-www-form-urlencoded',
+            'User-Agent'   =>"Plangrade Ruby Gem #{Plangrade::Ruby::VERSION}"})
+        model = DummyModel.new(:id => 42, :name => 'jim', :email => 'compliance@plangrade.com')
+        model.name = 'smithy'
+        model.save
+      end
+    end
+
+    describe "#base_name" do
+      it 'returns true' do
+        expect(subject.base_name).to eq 'dummy_model'
+      end
+    end
+
+    describe "setters" do
+      it 'should update modified attributes hash' do
+        subject
+      end
+    end
+
+    describe "#save" do
+
+      context 'unmodified model' do
+        it 'does nothing' do
+          expect(subject.save).to eq subject
+        end
+      end
+
+      context 'modified model' do
+        subject { DummyModel.new(:id => 42, :name => 'john', :email => 'compliance@plangrade.com') }
+
+        it 'should update model' do
+          api_handler = double("ApiHandler")
+          api_handler.should_receive(:update_dummy_model).with(42, hash_including(
+            :name =>'john',
+            :email => 'support@plangrade.com')
+          ).and_return(double('Response', :success? => true, :created? => true, :body => {:id => 2}))
+
+          subject.stub(:api_handler).and_return(api_handler)
+          subject.name = 'john'
+          subject.email = 'support@plangrade.com'
+          subject.save
+        end
+      end
+
+      context 'unmodified new model' do
+        subject { DummyModel.new(:name => 'jim', :email => 'compliance@plangrade.com') }
+
+        it 'should do nothing' do
+          api_handler = double("ApiHandler")
+          api_handler.should_receive(:create_dummy_model).with(
+            hash_including(:name =>'jim', :email => 'compliance@plangrade.com')
+          ).and_return(double('Response', :success? => true, :created? => true, :body => {:id => '2'}))
+
+          subject.stub(:api_handler).and_return(api_handler)
+          subject.save
+        end
+      end
+
+      context 'modified new model' do
+        subject { DummyModel.new(:name => 'jim', :email => 'compliance@plangrade.com') }
+
+        it 'should create model' do
+          api_handler = double("ApiHandler")
+          api_handler.should_receive(:create_dummy_model).with({
+            :name =>'john',
+            :email => 'compliance@plangrade.com'
+          }).and_return(double('Response', :success? => true, :created? => true, :body => {:id => 2}))
+
+          subject.stub(:api_handler).and_return(api_handler)
+          subject.name = 'john'
+          subject.save
+        end
+      end
+    end
+  end
+end

data/spec/resources/company_spec.rb

@@ -0,0 +1,135 @@
+# -*- encoding: utf-8 -*-
+
+# Copyright (c) Microsoft Corporation
+# All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# THIS CODE IS PROVIDED *AS IS* BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
+# ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION ANY
+# IMPLIED WARRANTIES OR CONDITIONS OF TITLE, FITNESS FOR A PARTICULAR
+# PURPOSE, MERCHANTABLITY OR NON-INFRINGEMENT.
+#
+# See the Apache Version 2.0 License for specific language governing
+# permissions and limitations under the License.
+
+require File.expand_path('../../spec_helper', __FILE__)
+
+describe Plangrade::Resources::Company do
+
+  before :all do
+    Plangrade.configure do |conf|
+      conf.access_token = 'TolNOFka9Uls2DxahNi78A'
+    end
+  end
+
+  after :all do
+    Plangrade.reset!
+  end
+
+  context 'class methods' do
+
+    subject { Plangrade::Resources::Company }
+
+    describe '#create' do
+      it 'creates a new company' do
+        stub_request(:post, "https://plangrade.com/api/v1/companies").with(
+          :body    => { :name => "plangrade, llc", :ein => '123456789' },
+          :headers => {
+            'Accept'          => 'application/json',
+            'Authorization'   => "Bearer #{Plangrade.access_token}",
+            'Content-Type'    => 'application/x-www-form-urlencoded',
+            'User-Agent'      => "Plangrade Ruby Gem #{Plangrade::Ruby::VERSION}"
+          }
+        ).to_return(
+          :status => 201,
+          :body => '',
+          :headers => { 'Location' => 'https://plangrade.com/api/v1/companies/4'}
+        )
+        subject.create("123456789", "plangrade, llc")
+      end
+    end
+  end
+
+  context 'new company object with id' do
+
+    before :each do
+      Plangrade::Resources::Company.identity_map.purge!
+    end
+
+    subject { Plangrade::Resources::Company.new(:id => 1) }
+
+    describe "#id" do
+      it 'returns id' do
+        expect(subject.id).to eq 1
+      end
+    end
+  end
+
+  context 'hydrated user object' do
+    subject { Plangrade::Resources::Company.new(MultiJson.load(fixture('company.json'), :symbolize_keys => true)) }
+
+    describe "#id" do
+      it 'returns id' do
+        expect(subject.id).to eq 4
+      end
+    end
+
+    describe "#ein" do
+      it 'returns ein' do
+        stub_request(:get, "https://plangrade.com/api/v1/companies/4").
+         with(:headers => {
+          'Accept'=>'application/json',
+          'Authorization'=>"Bearer #{Plangrade.access_token}",
+          'User-Agent'=>"Plangrade Ruby Gem #{Plangrade::Ruby::VERSION}"
+        }).to_return(
+          :status => 200,
+          :body => fixture('company.json'),
+          :headers => {}
+        )
+        expect(subject.ein).to eq '123456789'
+      end
+    end
+
+    describe "#delete" do
+      it 'deletes company' do
+        stub_request(:delete, "https://plangrade.com/api/v1/companies/4").
+         with(:headers => {
+          'Accept'=>'application/json',
+          'Authorization'=>"Bearer #{Plangrade.access_token}",
+          'User-Agent'=>"Plangrade Ruby Gem #{Plangrade::Ruby::VERSION}"
+        }).to_return(
+          :status => 200,
+          :body => '',
+          :headers => {}
+        )
+        subject.delete!
+      end
+    end
+
+    describe '#update' do
+      context 'with id as an integer' do
+        it 'updates company' do
+          stub_request(:put, "https://plangrade.com/api/v1/companies/4").with(
+            :body    => { :name => 'plangrade, llc' },
+            :headers => {
+              'Accept'          => 'application/json',
+              'Authorization'   => "Bearer #{Plangrade.access_token}",
+              'Content-Type'    => 'application/x-www-form-urlencoded',
+              'User-Agent'      => "Plangrade Ruby Gem #{Plangrade::Ruby::VERSION}"
+            }
+          ).to_return(
+            :status => 200,
+            :body => '',
+            :headers => { 'Location' => 'https://plangrade.com/api/v1/companies/4'}
+          )
+          subject.update!(:name => 'plangrade, llc')
+        end
+      end
+    end
+  end
+end

data/spec/resources/identity_map_spec.rb

@@ -0,0 +1,127 @@
+# -*- encoding: utf-8 -*-
+
+# Copyright (c) Microsoft Corporation
+# All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# THIS CODE IS PROVIDED *AS IS* BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
+# ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION ANY
+# IMPLIED WARRANTIES OR CONDITIONS OF TITLE, FITNESS FOR A PARTICULAR
+# PURPOSE, MERCHANTABLITY OR NON-INFRINGEMENT.
+#
+# See the Apache Version 2.0 License for specific language governing
+# permissions and limitations under the License.
+
+require File.expand_path('../../spec_helper', __FILE__)
+require 'plangrade/resources/identity_map'
+
+describe Plangrade::Resources::IdentityMap do
+
+  subject { Plangrade::Resources::IdentityMap.new }
+  
+  after :each do
+    subject.purge!
+  end
+
+  context 'after initialization' do
+    describe '#size' do
+      it 'should be zero' do
+        expect(subject.size).to eq 0
+      end
+    end
+
+    describe '#get' do
+      context 'with string parameter' do
+        it 'should return nil' do
+          expect(subject.get(:key)).to eq nil
+        end
+      end
+
+      context 'with symbol parameter' do
+        it 'should return nil' do
+          expect(subject.get('key')).to eq nil
+        end
+      end
+    end
+  end
+
+  context 'with data' do
+    describe '#put' do
+      context 'with nil key' do
+        it 'should throw exception' do
+          expect { subject.put(nil, 'value') }.to raise_error(Plangrade::Resources::IdentityMap::InvalidKeyError)
+        end
+      end
+
+      context 'with empty string' do
+        it 'should throw exception' do
+          expect { subject.put('', 'value') }.to raise_error(Plangrade::Resources::IdentityMap::InvalidKeyError)
+        end
+      end
+
+      it 'should store new value' do
+        subject.put('user_1', 'smith')
+        expect(subject.size).to eq 1
+        expect(subject.get('user_1')).to eq 'smith'
+      end
+
+      it 'should overwrite existing value' do
+        subject.put('user_1', 'smith')
+        subject.put('user_1', 'john')
+        expect(subject.size).to eq 1
+        expect(subject.get('user_1')).to eq 'john'
+      end
+    end
+
+    describe '#get' do
+      context 'with nil key' do
+        it 'should throw exception' do
+          expect(subject.get(nil)).to eq nil
+        end
+      end
+
+      context 'with empty string' do
+        it 'should throw exception' do
+          expect(subject.get('')).to eq nil
+        end
+      end
+
+      context 'with valid key' do
+        it 'should return a value' do
+          subject.put('user_1', 'smith')
+        end
+      end
+
+      context 'with valid key and default value' do
+        it 'should return default' do
+          subject.put('user_1', 'smith')
+          expect(subject.get('user_1', 'test')).to eq 'smith'
+        end
+      end
+
+      context 'with invalid key and default value' do
+        it 'should return default' do
+          expect(subject.get('user_1', 'test')).to eq 'test'
+        end
+      end
+    end
+  end
+
+  describe '#purge!' do
+    before do
+      subject.put('user_1', 'smith')
+      subject.put('user_2', 'john')
+    end
+
+    it 'empties the map' do
+      expect(subject.size).to eq 2
+      subject.purge!
+      expect(subject.size).to eq 0
+    end
+  end
+end