namely 0.0.1 → 0.1.0

data/spec/fixtures/vcr_cassettes/{report_show_missing.yml → reports_show_missing.yml}

@@ -25,9 +25,9 @@ http_interactions:
       Content-Type:
       - application/json; charset=utf-8
       Date:
-      - Tue, 04 Nov 2014 16:34:49 GMT
+      - Tue, 11 Nov 2014 16:10:17 GMT
       Server:
-      - nginx/1.6.2
+      - nginx
       Status:
       - 404 Not Found
       Strict-Transport-Security:
@@ -37,18 +37,18 @@ http_interactions:
       X-Rack-Cache:
       - miss
       X-Request-Id:
-      - 52e1e643-65de-487a-8b28-2be8291d2f1b
+      - 59152f7c-363e-4b32-af5a-afa1b6f92fa2
       X-Runtime:
-      - '0.025837'
+      - '0.043690'
       Content-Length:
-      - '64'
+      - '62'
       Connection:
       - keep-alive
     body:
       encoding: ASCII-8BIT
       string: !binary |-
         H4sIAAAAAAAAA6tWyk0tLk5MT1WyUgpKLcgvKlHIyy9RSMsvzUtR0lFKLSrK
-        LypWssorzcmpBQBUHrxBLAAAAA==
+        LypWsoqOrQUAFxI/qSoAAAA=
     http_version: 
-  recorded_at: Tue, 04 Nov 2014 16:34:49 GMT
+  recorded_at: Tue, 11 Nov 2014 16:10:17 GMT
 recorded_with: VCR 2.9.3

data/spec/fixtures/vcr_cassettes/token.yml

@@ -27,13 +27,13 @@ http_interactions:
       Content-Type:
       - application/json
       Date:
-      - Tue, 04 Nov 2014 16:38:10 GMT
+      - Wed, 05 Nov 2014 19:34:30 GMT
       Etag:
-      - '"fc3490b779796351d40312ba491c69c2"'
+      - '"d5351a93b070c18ad88f3eb2c60ec3cc"'
       Pragma:
       - no-cache
       Server:
-      - nginx
+      - nginx/1.6.2
       Status:
       - 200 OK
       Strict-Transport-Security:
@@ -42,9 +42,9 @@ http_interactions:
       X-Rack-Cache:
       - invalidate, pass
       X-Request-Id:
-      - 386d8523-f838-4023-a096-f74bc6c6291e
+      - 22bf7278-55c0-44bc-81b5-daac511edc48
       X-Runtime:
-      - '0.059499'
+      - '0.065517'
       Content-Length:
       - '141'
       Connection:
@@ -53,5 +53,5 @@ http_interactions:
       encoding: UTF-8
       string: '{"access_token":"<%= access_token %>","refresh_token":"<%= refresh_token %>","token_type":"bearer","expires_in":899}'
     http_version: 
-  recorded_at: Tue, 04 Nov 2014 16:38:11 GMT
+  recorded_at: Wed, 05 Nov 2014 19:34:30 GMT
 recorded_with: VCR 2.9.3

data/spec/namely/authenticator_spec.rb

@@ -79,6 +79,24 @@ describe Namely::Authenticator do
       expect(parsed_uri.scheme).to eq "http"
       expect(parsed_uri.host).to eq "testing.example.com"
     end
+
+    it "accepts a state parameter" do
+      authenticator = described_class.new(
+        client_id: "MY_CLIENT_ID",
+        client_secret: "MY_CLIENT_SECRET",
+      )
+
+      state = "this-is-a-piece-of-state"
+
+      authorization_code_url = authenticator.authorization_code_url(
+        subdomain: "ellingsonmineral",
+        state: state,
+      )
+
+      parsed_uri = URI(authorization_code_url)
+      parsed_query = CGI.parse(parsed_uri.query)
+      expect(parsed_query["state"]).to eq [state]
+    end
   end
 
   describe "#retrieve_tokens" do
@@ -140,4 +158,22 @@ describe Namely::Authenticator do
       end
     end
   end
+
+  describe "#current_user" do
+    it "returns the profile of the current user" do
+      VCR.use_cassette("current_user") do
+        authenticator = described_class.new(
+          client_id: "MY_CLIENT_ID",
+          client_secret: "MY_CLIENT_SECRET",
+        )
+
+        profile = authenticator.current_user(
+          access_token: ENV.fetch("TEST_ACCESS_TOKEN"),
+          subdomain: ENV.fetch("TEST_SUBDOMAIN"),
+        )
+
+        expect(profile.id).to eq "459748d5-608c-4dce-bca9-49a066d7f3d0"
+      end
+    end
+  end
 end

data/spec/namely/connection_spec.rb

@@ -0,0 +1,15 @@
+require "spec_helper"
+
+describe Namely::Connection do
+  describe "#initialize" do
+    context "when no provided an access token or subdomain" do
+      it "raises an ArgumentError" do
+        expect { Namely::Connection.new }.to raise_error ArgumentError
+        expect { Namely::Connection.new(access_token: "token") }.
+          to raise_error ArgumentError
+        expect { Namely::Connection.new(subdomain: "subdomain") }.
+          to raise_error ArgumentError
+      end
+    end
+  end
+end

data/spec/namely/integration_spec.rb

@@ -0,0 +1,94 @@
+require "spec_helper"
+
+describe "integration tests" do
+  describe "country collections" do
+    subject { conn.countries }
+
+    it_behaves_like(
+      "a resource with an index action",
+      [:id, :name, :subdivision_type]
+    )
+
+    it_behaves_like(
+      "a resource with a show action",
+      id: "US",
+      name: "United States",
+      subdivision_type: "State"
+    )
+  end
+
+  describe "currency type collections" do
+    subject { conn.currency_types }
+
+    it_behaves_like "a resource with an index action"
+  end
+
+  describe "event collections" do
+    subject { conn.events }
+
+    it_behaves_like "a resource with an index action", [:type]
+
+    it_behaves_like(
+      "a resource with a show action",
+      id: "e5573698-3934-4abf-99cf-577b526d4789",
+      type: "recent_arrival",
+    )
+  end
+
+  describe "field collections" do
+    subject { conn.fields }
+
+    it_behaves_like "a resource with an index action"
+  end
+
+  describe "job tier collections" do
+    subject { conn.job_tiers }
+
+    it_behaves_like "a resource with an index action", [:title]
+  end
+
+  describe "profile collections" do
+    subject { conn.profiles }
+
+    it_behaves_like(
+      "a resource with an index action",
+      [:first_name, :last_name]
+    )
+
+    it_behaves_like(
+      "a resource with a show action",
+      id: "20332458-c1fe-412f-bcb8-01622f04a35d",
+      first_name: "Leighton",
+      last_name: "Meester"
+    )
+
+    it_behaves_like(
+      "a resource with a create action",
+      first_name: "Beardsly",
+      last_name: "McDog",
+      email: "beardsly-#{Time.now.utc.to_f}@namely.com"
+    )
+
+    it_behaves_like(
+      "a resource with an update action",
+      "20332458-c1fe-412f-bcb8-01622f04a35d",
+      middle_name: "Beardsly"
+    )
+  end
+
+  describe "report collections" do
+    subject { conn.reports }
+
+    it_behaves_like(
+      "a resource with a show action",
+      id: "bbf089f6-90c5-473c-8928-058014a462c9"
+    )
+  end
+
+  def conn
+    Namely::Connection.new(
+      access_token: ENV.fetch("TEST_ACCESS_TOKEN"),
+      subdomain: ENV.fetch("TEST_SUBDOMAIN"),
+    )
+  end
+end

data/spec/namely/resource_gateway_spec.rb

@@ -1,12 +1,20 @@
 require "spec_helper"
 
 describe Namely::ResourceGateway do
+  def access_token
+    ENV.fetch("TEST_ACCESS_TOKEN")
+  end
+
+  def subdomain
+    ENV.fetch("TEST_SUBDOMAIN")
+  end
+
   def gateway
     @gateway ||= Namely::ResourceGateway.new(
-      access_token: Namely.configuration.access_token,
+      access_token: access_token,
       endpoint: "widgets",
       resource_name: "widgets",
-      subdomain: Namely.configuration.subdomain
+      subdomain: subdomain,
     )
   end
 
@@ -22,10 +30,10 @@ describe Namely::ResourceGateway do
     it "returns the parsed JSON representation of #index" do
       stub_request(
         :get,
-        "https://#{Namely.configuration.subdomain}.namely.com/api/v1/widgets"
+        "https://#{subdomain}.namely.com/api/v1/widgets"
       ).with(
         query: {
-          access_token: Namely.configuration.access_token,
+          access_token: access_token,
           limit: :all
         }
       ).to_return(
@@ -41,10 +49,10 @@ describe Namely::ResourceGateway do
     it "returns the parsed JSON representation of #show" do
       stub_request(
         :get,
-        "https://#{Namely.configuration.subdomain}.namely.com/api/v1/widgets/#{valid_id}"
+        "https://#{subdomain}.namely.com/api/v1/widgets/#{valid_id}"
       ).with(
         query: {
-          access_token: Namely.configuration.access_token
+          access_token: access_token
         }
       ).to_return(
         body: "{\"widgets\": [{\"name\": \"wilbur\", \"favorite_color\": \"chartreuse\"}]}",
@@ -62,10 +70,10 @@ describe Namely::ResourceGateway do
     it "returns an empty response if it succeeds" do
       stub_request(
         :head,
-        "https://#{Namely.configuration.subdomain}.namely.com/api/v1/widgets/#{valid_id}"
+        "https://#{subdomain}.namely.com/api/v1/widgets/#{valid_id}"
       ).with(
         query: {
-          access_token: Namely.configuration.access_token
+          access_token: access_token
         }
       ).to_return(
         body: "",
@@ -78,10 +86,10 @@ describe Namely::ResourceGateway do
     it "raises a RestClient::ResourceNotFound error if it fails" do
       stub_request(
         :head,
-        "https://#{Namely.configuration.subdomain}.namely.com/api/v1/widgets/#{invalid_id}"
+        "https://#{subdomain}.namely.com/api/v1/widgets/#{invalid_id}"
       ).with(
         query: {
-          access_token: Namely.configuration.access_token
+          access_token: access_token
         }
       ).to_return(
         status: 404

data/spec/shared_examples/a_resource_with_a_create_action.rb

@@ -0,0 +1,24 @@
+shared_examples "a resource with a create action" do |model_attributes|
+  def invalid_attributes
+    {}
+  end
+
+  describe "#create" do
+    it "creates a model based on a hash of attributes" do
+      model = nil
+
+      VCR.use_cassette("#{subject.endpoint}_create") do
+        model = subject.create!(model_attributes)
+      end
+
+      expect(model).to respond_to :id
+      expect(model.id).not_to be_empty
+    end
+
+    it "raises a FailedRequestError when the create action fails" do
+      VCR.use_cassette("#{subject.endpoint}_create_failed") do
+        expect { subject.create!(invalid_attributes) }.to raise_error Namely::FailedRequestError
+      end
+    end
+  end
+end

data/spec/shared_examples/a_resource_with_a_show_action.rb

@@ -0,0 +1,38 @@
+shared_examples "a resource with a show action" do |model_attributes|
+  def invalid_id
+    "this-is-almost-certainly-not-the-id-of-any-model"
+  end
+
+  describe "#find" do
+    it "finds a model by its unique id" do
+      VCR.use_cassette("#{subject.endpoint}_show") do
+        object = subject.find(model_attributes[:id])
+
+        expect(object).to be_a Namely::Model
+        model_attributes.each do |method, value|
+          expect(object.public_send(method)).to eq value
+        end
+      end
+    end
+
+    it "raises an error if that model can't be found" do
+      VCR.use_cassette("#{subject.endpoint}_show_missing") do
+        expect { subject.find(invalid_id) }.to raise_error Namely::NoSuchModelError
+      end
+    end
+  end
+
+  describe "#exists?" do
+    it "returns true if a model exists" do
+      VCR.use_cassette("#{subject.endpoint}_head") do
+        expect(subject.exists?(model_attributes[:id])).to eq true
+      end
+    end
+
+    it "returns false if a model doesn't exist" do
+      VCR.use_cassette("#{subject.endpoint}_head_missing") do
+        expect(subject.exists?(invalid_id)).to eq false
+      end
+    end
+  end
+end

data/spec/shared_examples/a_resource_with_an_index_action.rb

@@ -0,0 +1,15 @@
+shared_examples "a resource with an index action" do |instance_methods = []|
+  it "returns every model" do
+    VCR.use_cassette("#{subject.endpoint}_index") do
+      objects = subject.all
+
+      expect(objects).not_to be_empty
+      objects.each do |object|
+        expect(object).to be_a Namely::Model
+        instance_methods.each do |instance_method|
+          expect(object).to respond_to instance_method
+        end
+      end
+    end
+  end
+end

data/spec/shared_examples/{a_model_with_an_update_action.rb → a_resource_with_an_update_action.rb}

@@ -1,25 +1,26 @@
-shared_examples_for "a model with an update action" do |valid_id, changes|
+shared_examples_for "a resource with an update action" do |valid_id, changes|
   describe "#update" do
     it "updates an existing object" do
       model = nil
-      original_values = nil
 
-      VCR.use_cassette("#{classname}_show") do
-        model = described_class.find(valid_id)
+      VCR.use_cassette("#{subject.endpoint}_show") do
+        model = subject.find(valid_id)
       end
 
       changes.each do |attribute, value|
         expect(model[attribute]).not_to eq value
       end
 
-      original_values = model.to_h.select { |attribute, _| changes.keys.include?(attribute) }
+      original_values = model.to_h.select do |attribute, _|
+        changes.keys.include?(attribute)
+      end
 
-      VCR.use_cassette("#{classname}_update") do
+      VCR.use_cassette("#{subject.endpoint}_update") do
         model.update(changes)
       end
 
-      VCR.use_cassette("#{classname}_show_updated") do
-        model = described_class.find(valid_id)
+      VCR.use_cassette("#{subject.endpoint}_show_updated") do
+        model = subject.find(valid_id)
       end
       changes.each do |attribute, value|
         expect(model[attribute]).to eq value
@@ -30,7 +31,7 @@ shared_examples_for "a model with an update action" do |valid_id, changes|
   end
 
   def revert_changes(model, original_values)
-    VCR.use_cassette("#{classname}_update_revert") do
+    VCR.use_cassette("#{subject.endpoint}_update_revert") do
       model.update(original_values)
     end
   end

data/spec/spec_helper.rb

@@ -30,20 +30,3 @@ VCR.configure do |config|
     end
   end
 end
-
-def classname
-  described_class.name.split("::").last.downcase
-end
-
-def set_configuration!
-  Namely.configure do |config|
-    config.access_token = ENV.fetch("TEST_ACCESS_TOKEN")
-    config.subdomain = ENV.fetch("TEST_SUBDOMAIN")
-  end
-end
-
-def unset_configuration!
-  Namely.configuration = nil
-end
-
-set_configuration!