namely 0.0.1

data/spec/namely/configuration_spec.rb

@@ -0,0 +1,33 @@
+require "spec_helper"
+
+describe Namely::Configuration do
+  before :each do
+    unset_configuration!
+  end
+
+  after :each do
+    set_configuration!
+  end
+
+  it "contains a subdomain and access_token when those have been set" do
+    Namely.configure do |config|
+      config.access_token = "my_token"
+      config.subdomain = "my_subdomain"
+    end
+
+    expect(Namely.configuration.access_token).to eq "my_token"
+    expect(Namely.configuration.subdomain).to eq "my_subdomain"
+  end
+
+  it "raises an error when the configuration block hasn't been run" do
+    expect { Namely.configuration }.to raise_error Namely::ImproperlyConfiguredError
+  end
+
+  it "raises an error when variables haven't been set in the config" do
+    Namely.configure do
+    end
+
+    expect { Namely.configuration.access_token }.to raise_error Namely::ImproperlyConfiguredError
+    expect { Namely.configuration.subdomain }.to raise_error Namely::ImproperlyConfiguredError
+  end
+end

data/spec/namely/country_spec.rb

@@ -0,0 +1,11 @@
+require "spec_helper"
+
+describe Namely::Country do
+  it_behaves_like "a model with an index action", [:id, :name, :subdivision_type]
+  it_behaves_like(
+    "a model with a show action",
+    id: "US",
+    name: "United States",
+    subdivision_type: "State"
+  )
+end

data/spec/namely/currency_type_spec.rb

@@ -0,0 +1,5 @@
+require "spec_helper"
+
+describe Namely::CurrencyType do
+  it_behaves_like "a model with an index action"
+end

data/spec/namely/event_spec.rb

@@ -0,0 +1,11 @@
+require "spec_helper"
+
+describe Namely::Event do
+  it_behaves_like "a model with an index action", [:type]
+
+  it_behaves_like(
+    "a model with a show action",
+    id: "e5573698-3934-4abf-99cf-577b526d4789",
+    type: "recent_arrival",
+  )
+end

data/spec/namely/field_spec.rb

@@ -0,0 +1,5 @@
+require "spec_helper"
+
+describe Namely::Field do
+  it_behaves_like "a model with an index action"
+end

data/spec/namely/job_tier_spec.rb

@@ -0,0 +1,5 @@
+require "spec_helper"
+
+describe Namely::JobTier do
+  it_behaves_like "a model with an index action", [:title]
+end

data/spec/namely/profile_spec.rb

@@ -0,0 +1,25 @@
+require "spec_helper"
+
+describe Namely::Profile do
+  it_behaves_like "a model with an index action", [:first_name, :last_name]
+
+  it_behaves_like(
+    "a model with a show action",
+    id: "20332458-c1fe-412f-bcb8-01622f04a35d",
+    first_name: "Leighton",
+    last_name: "Meester"
+  )
+
+  it_behaves_like(
+    "a model with a create action",
+    first_name: "Beardsly",
+    last_name: "McDog",
+    email: "beardsly-#{Time.now.utc.to_f}@namely.com"
+  )
+
+  it_behaves_like(
+    "a model with an update action",
+    "20332458-c1fe-412f-bcb8-01622f04a35d",
+    middle_name: "Beardsly"
+  )
+end

data/spec/namely/report_spec.rb

@@ -0,0 +1,8 @@
+require "spec_helper"
+
+describe Namely::Report do
+  it_behaves_like(
+    "a model with a show action",
+    id: "bbf089f6-90c5-473c-8928-058014a462c9"
+  )
+end

data/spec/namely/resource_gateway_spec.rb

@@ -0,0 +1,93 @@
+require "spec_helper"
+
+describe Namely::ResourceGateway do
+  def gateway
+    @gateway ||= Namely::ResourceGateway.new(
+      access_token: Namely.configuration.access_token,
+      endpoint: "widgets",
+      resource_name: "widgets",
+      subdomain: Namely.configuration.subdomain
+    )
+  end
+
+  def valid_id
+    "this-is-a-valid-id"
+  end
+
+  def invalid_id
+    "this-is-not-a-valid-id"
+  end
+
+  describe "#json_index" do
+    it "returns the parsed JSON representation of #index" do
+      stub_request(
+        :get,
+        "https://#{Namely.configuration.subdomain}.namely.com/api/v1/widgets"
+      ).with(
+        query: {
+          access_token: Namely.configuration.access_token,
+          limit: :all
+        }
+      ).to_return(
+        body: "{\"widgets\": [\"woo!\"]}",
+        status: 200
+      )
+
+      expect(gateway.json_index).to eq ["woo!"]
+    end
+  end
+
+  describe "#json_show" do
+    it "returns the parsed JSON representation of #show" do
+      stub_request(
+        :get,
+        "https://#{Namely.configuration.subdomain}.namely.com/api/v1/widgets/#{valid_id}"
+      ).with(
+        query: {
+          access_token: Namely.configuration.access_token
+        }
+      ).to_return(
+        body: "{\"widgets\": [{\"name\": \"wilbur\", \"favorite_color\": \"chartreuse\"}]}",
+        status: 200
+      )
+
+      widget = gateway.json_show(valid_id)
+
+      expect(widget["name"]).to eq "wilbur"
+      expect(widget["favorite_color"]).to eq "chartreuse"
+    end
+  end
+
+  describe "#show_head" do
+    it "returns an empty response if it succeeds" do
+      stub_request(
+        :head,
+        "https://#{Namely.configuration.subdomain}.namely.com/api/v1/widgets/#{valid_id}"
+      ).with(
+        query: {
+          access_token: Namely.configuration.access_token
+        }
+      ).to_return(
+        body: "",
+        status: 200
+      )
+
+      expect(gateway.show_head(valid_id)).to be_empty
+    end
+
+    it "raises a RestClient::ResourceNotFound error if it fails" do
+      stub_request(
+        :head,
+        "https://#{Namely.configuration.subdomain}.namely.com/api/v1/widgets/#{invalid_id}"
+      ).with(
+        query: {
+          access_token: Namely.configuration.access_token
+        }
+      ).to_return(
+        status: 404
+      )
+
+      expect { gateway.show_head(invalid_id) }.to raise_error RestClient::ResourceNotFound
+    end
+  end
+end

data/spec/shared_examples/a_model_with_a_create_action.rb

@@ -0,0 +1,24 @@
+shared_examples_for "a model 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("#{classname}_create") do
+        model = described_class.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("#{classname}_create_failed") do
+        expect { described_class.create!(invalid_attributes) }.to raise_error Namely::FailedRequestError
+      end
+    end
+  end
+end

data/spec/shared_examples/a_model_with_a_show_action.rb

@@ -0,0 +1,38 @@
+shared_examples_for "a model 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("#{classname}_show") do
+        object = described_class.find(model_attributes[:id])
+
+        expect(object).to be_a described_class
+        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("#{classname}_show_missing") do
+        expect { described_class.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("#{classname}_head") do
+        expect(described_class.exists?(model_attributes[:id])).to eq true
+      end
+    end
+
+    it "returns false if a model doesn't exist" do
+      VCR.use_cassette("#{classname}_head_missing") do
+        expect(described_class.exists?(invalid_id)).to eq false
+      end
+    end
+  end
+end

data/spec/shared_examples/a_model_with_an_index_action.rb

@@ -0,0 +1,17 @@
+shared_examples_for "a model with an index action" do |instance_methods = []|
+  describe ".all" do
+    it "returns every model" do
+      VCR.use_cassette("#{classname}_index") do
+        objects = described_class.all
+
+        expect(objects).not_to be_empty
+        objects.each do |object|
+          expect(object).to be_a described_class
+          instance_methods.each do |instance_method|
+            expect(object).to respond_to instance_method
+          end
+        end
+      end
+    end
+  end
+end

data/spec/shared_examples/a_model_with_an_update_action.rb

@@ -0,0 +1,37 @@
+shared_examples_for "a model 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)
+      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) }
+
+      VCR.use_cassette("#{classname}_update") do
+        model.update(changes)
+      end
+
+      VCR.use_cassette("#{classname}_show_updated") do
+        model = described_class.find(valid_id)
+      end
+      changes.each do |attribute, value|
+        expect(model[attribute]).to eq value
+      end
+
+      revert_changes(model, original_values)
+    end
+  end
+
+  def revert_changes(model, original_values)
+    VCR.use_cassette("#{classname}_update_revert") do
+      model.update(original_values)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,49 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), "..", "lib"))
+
+Dir[File.join(File.dirname(__FILE__), "shared_examples", "*")].each { |f| require f }
+
+require "namely"
+require "dotenv"
+require "vcr"
+require "webmock/rspec"
+
+Dotenv.load
+
+VCR.configure do |config|
+  config.cassette_library_dir = "spec/fixtures/vcr_cassettes"
+  config.hook_into :webmock
+
+  environment_variables = [
+    "AUTH_CODE",
+    "CLIENT_ID",
+    "CLIENT_REDIRECT_URI",
+    "CLIENT_SECRET",
+    "TEST_ACCESS_TOKEN",
+    "TEST_REFRESH_TOKEN",
+    "TEST_SUBDOMAIN",
+  ]
+
+  environment_variables.each do |env_var|
+    config.filter_sensitive_data("<#{env_var}>") do
+      ENV.fetch(env_var)
+    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!

metadata

@@ -0,0 +1,280 @@
+--- !ruby/object:Gem::Specification
+name: namely
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Harry Schwartz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: backports
+  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'
+- !ruby/object:Gem::Dependency
+  name: rest_client
+  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'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.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: 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: 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: yard
+  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'
+description: 
+email:
+- harry@thoughtbot.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/namely.rb
+- lib/namely/authenticator.rb
+- lib/namely/country.rb
+- lib/namely/currency_type.rb
+- lib/namely/event.rb
+- lib/namely/exceptions.rb
+- lib/namely/field.rb
+- lib/namely/job_tier.rb
+- lib/namely/profile.rb
+- lib/namely/report.rb
+- lib/namely/resource_gateway.rb
+- lib/namely/restful_model.rb
+- lib/namely/version.rb
+- namely.gemspec
+- spec/fixtures/vcr_cassettes/country_head.yml
+- spec/fixtures/vcr_cassettes/country_head_missing.yml
+- spec/fixtures/vcr_cassettes/country_index.yml
+- spec/fixtures/vcr_cassettes/country_show.yml
+- spec/fixtures/vcr_cassettes/country_show_missing.yml
+- spec/fixtures/vcr_cassettes/currencytype_index.yml
+- spec/fixtures/vcr_cassettes/event_head.yml
+- spec/fixtures/vcr_cassettes/event_head_missing.yml
+- spec/fixtures/vcr_cassettes/event_index.yml
+- spec/fixtures/vcr_cassettes/event_show.yml
+- spec/fixtures/vcr_cassettes/event_show_missing.yml
+- spec/fixtures/vcr_cassettes/field_index.yml
+- spec/fixtures/vcr_cassettes/jobtier_index.yml
+- spec/fixtures/vcr_cassettes/profile_create.yml
+- spec/fixtures/vcr_cassettes/profile_create_failed.yml
+- spec/fixtures/vcr_cassettes/profile_head.yml
+- spec/fixtures/vcr_cassettes/profile_head_missing.yml
+- spec/fixtures/vcr_cassettes/profile_index.yml
+- spec/fixtures/vcr_cassettes/profile_show.yml
+- spec/fixtures/vcr_cassettes/profile_show_missing.yml
+- spec/fixtures/vcr_cassettes/profile_show_updated.yml
+- spec/fixtures/vcr_cassettes/profile_update.yml
+- spec/fixtures/vcr_cassettes/profile_update_revert.yml
+- spec/fixtures/vcr_cassettes/report_head.yml
+- spec/fixtures/vcr_cassettes/report_head_missing.yml
+- spec/fixtures/vcr_cassettes/report_show.yml
+- spec/fixtures/vcr_cassettes/report_show_missing.yml
+- spec/fixtures/vcr_cassettes/token.yml
+- spec/fixtures/vcr_cassettes/token_refresh.yml
+- spec/namely/authenticator_spec.rb
+- spec/namely/configuration_spec.rb
+- spec/namely/country_spec.rb
+- spec/namely/currency_type_spec.rb
+- spec/namely/event_spec.rb
+- spec/namely/field_spec.rb
+- spec/namely/job_tier_spec.rb
+- spec/namely/profile_spec.rb
+- spec/namely/report_spec.rb
+- spec/namely/resource_gateway_spec.rb
+- spec/shared_examples/a_model_with_a_create_action.rb
+- spec/shared_examples/a_model_with_a_show_action.rb
+- spec/shared_examples/a_model_with_an_index_action.rb
+- spec/shared_examples/a_model_with_an_update_action.rb
+- spec/spec_helper.rb
+homepage: https://github.com/namely/ruby-client
+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: Wraps the Namely HTTP API in lovely Ruby.
+test_files:
+- spec/fixtures/vcr_cassettes/country_head.yml
+- spec/fixtures/vcr_cassettes/country_head_missing.yml
+- spec/fixtures/vcr_cassettes/country_index.yml
+- spec/fixtures/vcr_cassettes/country_show.yml
+- spec/fixtures/vcr_cassettes/country_show_missing.yml
+- spec/fixtures/vcr_cassettes/currencytype_index.yml
+- spec/fixtures/vcr_cassettes/event_head.yml
+- spec/fixtures/vcr_cassettes/event_head_missing.yml
+- spec/fixtures/vcr_cassettes/event_index.yml
+- spec/fixtures/vcr_cassettes/event_show.yml
+- spec/fixtures/vcr_cassettes/event_show_missing.yml
+- spec/fixtures/vcr_cassettes/field_index.yml
+- spec/fixtures/vcr_cassettes/jobtier_index.yml
+- spec/fixtures/vcr_cassettes/profile_create.yml
+- spec/fixtures/vcr_cassettes/profile_create_failed.yml
+- spec/fixtures/vcr_cassettes/profile_head.yml
+- spec/fixtures/vcr_cassettes/profile_head_missing.yml
+- spec/fixtures/vcr_cassettes/profile_index.yml
+- spec/fixtures/vcr_cassettes/profile_show.yml
+- spec/fixtures/vcr_cassettes/profile_show_missing.yml
+- spec/fixtures/vcr_cassettes/profile_show_updated.yml
+- spec/fixtures/vcr_cassettes/profile_update.yml
+- spec/fixtures/vcr_cassettes/profile_update_revert.yml
+- spec/fixtures/vcr_cassettes/report_head.yml
+- spec/fixtures/vcr_cassettes/report_head_missing.yml
+- spec/fixtures/vcr_cassettes/report_show.yml
+- spec/fixtures/vcr_cassettes/report_show_missing.yml
+- spec/fixtures/vcr_cassettes/token.yml
+- spec/fixtures/vcr_cassettes/token_refresh.yml
+- spec/namely/authenticator_spec.rb
+- spec/namely/configuration_spec.rb
+- spec/namely/country_spec.rb
+- spec/namely/currency_type_spec.rb
+- spec/namely/event_spec.rb
+- spec/namely/field_spec.rb
+- spec/namely/job_tier_spec.rb
+- spec/namely/profile_spec.rb
+- spec/namely/report_spec.rb
+- spec/namely/resource_gateway_spec.rb
+- spec/shared_examples/a_model_with_a_create_action.rb
+- spec/shared_examples/a_model_with_a_show_action.rb
+- spec/shared_examples/a_model_with_an_index_action.rb
+- spec/shared_examples/a_model_with_an_update_action.rb
+- spec/spec_helper.rb