namely 0.0.1 → 0.1.0

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: namely
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Harry Schwartz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-05 00:00:00.000000000 Z
+date: 2015-03-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: backports
@@ -153,61 +153,52 @@ files:
 - Rakefile
 - lib/namely.rb
 - lib/namely/authenticator.rb
-- lib/namely/country.rb
-- lib/namely/currency_type.rb
-- lib/namely/event.rb
+- lib/namely/collection.rb
+- lib/namely/connection.rb
 - lib/namely/exceptions.rb
-- lib/namely/field.rb
-- lib/namely/job_tier.rb
-- lib/namely/profile.rb
-- lib/namely/report.rb
+- lib/namely/model.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/countries_head.yml
+- spec/fixtures/vcr_cassettes/countries_head_missing.yml
+- spec/fixtures/vcr_cassettes/countries_index.yml
+- spec/fixtures/vcr_cassettes/countries_show.yml
+- spec/fixtures/vcr_cassettes/countries_show_missing.yml
+- spec/fixtures/vcr_cassettes/currency_types_index.yml
+- spec/fixtures/vcr_cassettes/current_user.yml
+- spec/fixtures/vcr_cassettes/events_head.yml
+- spec/fixtures/vcr_cassettes/events_head_missing.yml
+- spec/fixtures/vcr_cassettes/events_index.yml
+- spec/fixtures/vcr_cassettes/events_show.yml
+- spec/fixtures/vcr_cassettes/events_show_missing.yml
+- spec/fixtures/vcr_cassettes/fields_index.yml
+- spec/fixtures/vcr_cassettes/job_tiers_index.yml
+- spec/fixtures/vcr_cassettes/profiles/fields_index.yml
+- spec/fixtures/vcr_cassettes/profiles_create.yml
+- spec/fixtures/vcr_cassettes/profiles_create_failed.yml
+- spec/fixtures/vcr_cassettes/profiles_head.yml
+- spec/fixtures/vcr_cassettes/profiles_head_missing.yml
+- spec/fixtures/vcr_cassettes/profiles_index.yml
+- spec/fixtures/vcr_cassettes/profiles_show.yml
+- spec/fixtures/vcr_cassettes/profiles_show_missing.yml
+- spec/fixtures/vcr_cassettes/profiles_show_updated.yml
+- spec/fixtures/vcr_cassettes/profiles_update.yml
+- spec/fixtures/vcr_cassettes/profiles_update_revert.yml
+- spec/fixtures/vcr_cassettes/reports_head.yml
+- spec/fixtures/vcr_cassettes/reports_head_missing.yml
+- spec/fixtures/vcr_cassettes/reports_show.yml
+- spec/fixtures/vcr_cassettes/reports_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/connection_spec.rb
+- spec/namely/integration_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/shared_examples/a_resource_with_a_create_action.rb
+- spec/shared_examples/a_resource_with_a_show_action.rb
+- spec/shared_examples/a_resource_with_an_index_action.rb
+- spec/shared_examples/a_resource_with_an_update_action.rb
 - spec/spec_helper.rb
 homepage: https://github.com/namely/ruby-client
 licenses:
@@ -234,47 +225,43 @@ 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/countries_head.yml
+- spec/fixtures/vcr_cassettes/countries_head_missing.yml
+- spec/fixtures/vcr_cassettes/countries_index.yml
+- spec/fixtures/vcr_cassettes/countries_show.yml
+- spec/fixtures/vcr_cassettes/countries_show_missing.yml
+- spec/fixtures/vcr_cassettes/currency_types_index.yml
+- spec/fixtures/vcr_cassettes/current_user.yml
+- spec/fixtures/vcr_cassettes/events_head.yml
+- spec/fixtures/vcr_cassettes/events_head_missing.yml
+- spec/fixtures/vcr_cassettes/events_index.yml
+- spec/fixtures/vcr_cassettes/events_show.yml
+- spec/fixtures/vcr_cassettes/events_show_missing.yml
+- spec/fixtures/vcr_cassettes/fields_index.yml
+- spec/fixtures/vcr_cassettes/job_tiers_index.yml
+- spec/fixtures/vcr_cassettes/profiles/fields_index.yml
+- spec/fixtures/vcr_cassettes/profiles_create.yml
+- spec/fixtures/vcr_cassettes/profiles_create_failed.yml
+- spec/fixtures/vcr_cassettes/profiles_head.yml
+- spec/fixtures/vcr_cassettes/profiles_head_missing.yml
+- spec/fixtures/vcr_cassettes/profiles_index.yml
+- spec/fixtures/vcr_cassettes/profiles_show.yml
+- spec/fixtures/vcr_cassettes/profiles_show_missing.yml
+- spec/fixtures/vcr_cassettes/profiles_show_updated.yml
+- spec/fixtures/vcr_cassettes/profiles_update.yml
+- spec/fixtures/vcr_cassettes/profiles_update_revert.yml
+- spec/fixtures/vcr_cassettes/reports_head.yml
+- spec/fixtures/vcr_cassettes/reports_head_missing.yml
+- spec/fixtures/vcr_cassettes/reports_show.yml
+- spec/fixtures/vcr_cassettes/reports_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/connection_spec.rb
+- spec/namely/integration_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/shared_examples/a_resource_with_a_create_action.rb
+- spec/shared_examples/a_resource_with_a_show_action.rb
+- spec/shared_examples/a_resource_with_an_index_action.rb
+- spec/shared_examples/a_resource_with_an_update_action.rb
 - spec/spec_helper.rb

data/lib/namely/country.rb

@@ -1,9 +0,0 @@
-module Namely
-  class Country < RestfulModel
-    def self.endpoint
-      "countries"
-    end
-
-    private_class_method :endpoint
-  end
-end

data/lib/namely/currency_type.rb

@@ -1,9 +0,0 @@
-module Namely
-  class CurrencyType < RestfulModel
-    def self.endpoint
-      "currency_types"
-    end
-
-    private_class_method :endpoint
-  end
-end

data/lib/namely/event.rb

@@ -1,9 +0,0 @@
-module Namely
-  class Event < RestfulModel
-    def self.endpoint
-      "events"
-    end
-
-    private_class_method :endpoint
-  end
-end

data/lib/namely/field.rb

@@ -1,9 +0,0 @@
-module Namely
-  class Field < RestfulModel
-    def self.endpoint
-      "profiles/fields"
-    end
-
-    private_class_method :endpoint, :resource_name
-  end
-end

data/lib/namely/job_tier.rb

@@ -1,9 +0,0 @@
-module Namely
-  class JobTier < RestfulModel
-    def self.endpoint
-      "job_tiers"
-    end
-
-    private_class_method :endpoint
-  end
-end

data/lib/namely/profile.rb

@@ -1,13 +0,0 @@
-module Namely
-  class Profile < RestfulModel
-    def self.endpoint
-      "profiles"
-    end
-
-    def required_keys_for_update
-      [:email]
-    end
-
-    private_class_method :endpoint, :resource_name
-  end
-end

data/lib/namely/report.rb

@@ -1,9 +0,0 @@
-module Namely
-  class Report < RestfulModel
-    def self.endpoint
-      "reports"
-    end
-
-    private_class_method :endpoint
-  end
-end

data/lib/namely/restful_model.rb

@@ -1,150 +0,0 @@
-module Namely
-  # @abstract
-  class RestfulModel < OpenStruct
-    # Fetch a model from the server by its ID.
-    #
-    # @param [#to_s] id
-    #
-    # @raise [NoSuchModelError] if the model wasn't found.
-    #
-    # @return [RestfulModel]
-    def self.find(id)
-      new(resource_gateway.json_show(id))
-    rescue RestClient::ResourceNotFound
-      raise NoSuchModelError, "Can't find a #{name} with id \"#{id}\""
-    end
-
-    # Returns true if a model with this ID exists, false otherwise.
-    #
-    # @param [#to_s] id
-    #
-    # @return [Boolean]
-    def self.exists?(id)
-      resource_gateway.show_head(id)
-      true
-    rescue RestClient::ResourceNotFound
-      false
-    end
-
-    # Return every instance of this model.
-    #
-    # A model might have quite a few instances. If this is the case,
-    # the query may take some time (several seconds) and the resulting
-    # array may be very large.
-    #
-    # @return [Array<RestfulModel>]
-    def self.all
-      resource_gateway.json_index.map { |model| new(model) }
-    end
-
-    # Create a new model on the server with the given attributes.
-    #
-    # @param [Hash] attributes the attributes of the model being created.
-    #
-    # @example
-    #   Profile.create!(
-    #     first_name: "Beardsly",
-    #     last_name: "McDog",
-    #     email: "beardsly@namely.com"
-    #   )
-    #
-    # @return [RestfulModel] the created model.
-    def self.create!(attributes)
-      new(attributes).save!
-    end
-
-    # Update the attributes of this model. Assign the attributes
-    # according to the hash, then persist those changes on the server.
-    #
-    # @param [Hash] attributes the attributes to be updated on the model.
-    #
-    # @example
-    #   my_profile.update(
-    #     middle_name: "Ludwig"
-    #   )
-    #
-    # @raise [FailedRequestError] if the request failed for any reason.
-    #
-    # @return [RestfulModel] the updated model.
-    def update(attributes)
-      attributes.each do |key, value|
-        self[key] = value
-      end
-
-      persist_model_changes(attributes)
-
-      self
-    end
-
-    # Try to persist the current object, either by creating a new
-    # object on the server or by updating an existing one. Raise an
-    # error if the object can't be saved.
-    #
-    # @raise [FailedRequestError] if the request failed for any reason.
-    #
-    # @return [RestfulModel] the model itself, if saving succeeded.
-    def save!
-      if persisted?
-        update(to_h)
-      else
-        self.id = resource_gateway.create(to_h)
-      end
-      self
-    rescue RestClient::Exception => e
-      raise FailedRequestError, e.message
-    end
-
-    # Return true if the model exists (in some state) on the server.
-    #
-    # @return [Boolean]
-    def persisted?
-      !!id
-    end
-
-    private
-
-    def resource_gateway
-      self.class.resource_gateway
-    end
-
-    def self.resource_gateway
-      Namely.resource_gateway(resource_name, endpoint)
-    end
-
-    def resource_gateway
-      self.class.resource_gateway
-    end
-
-    def self.endpoint
-      raise(
-        NotImplementedError,
-        "Namely::Model subclasses must define an `.endpoint` "\
-        "class method that returns their path in the API."
-      )
-    end
-
-    def self.resource_name
-      endpoint.split("/").last
-    end
-
-    # The update action for certain models requires populating certain
-    # fields. Without populating these fields, an update with
-    # fail. This method is intended to be overwritten by subclasses
-    # with required keys.
-    #
-    # @return [Array<Symbol>]
-    def required_keys_for_update
-      []
-    end
-
-    def required_attributes_for_update
-      to_h.select { |key, _| required_keys_for_update.include?(key) }
-    end
-
-    def persist_model_changes(changed_attributes)
-      resource_gateway.update(id, changed_attributes.merge(required_attributes_for_update))
-    rescue RestClient::Exception => e
-      raise FailedRequestError, e.message
-    end
-  end
-end

data/spec/fixtures/vcr_cassettes/event_index.yml

@@ -1,88 +0,0 @@
----
-http_interactions:
-- request:
-    method: get
-    uri: https://<TEST_SUBDOMAIN>.namely.com/api/v1/events?access_token=<TEST_ACCESS_TOKEN>&limit=all
-    body:
-      encoding: US-ASCII
-      string: ''
-    headers:
-      Accept:
-      - application/json
-      Accept-Encoding:
-      - gzip, deflate
-      User-Agent:
-      - Ruby
-  response:
-    status:
-      code: 200
-      message: OK
-    headers:
-      Cache-Control:
-      - max-age=0, private, must-revalidate
-      Content-Encoding:
-      - gzip
-      Content-Type:
-      - application/json; charset=utf-8
-      Date:
-      - Tue, 04 Nov 2014 16:34:37 GMT
-      Server:
-      - nginx
-      Status:
-      - 200 OK
-      Strict-Transport-Security:
-      - max-age=31536000
-      - max-age=31536000; includeSubDomains;
-      Vary:
-      - Accept-Encoding
-      X-Rack-Cache:
-      - miss
-      X-Request-Id:
-      - 5633b619-a52c-44be-9128-c136d0b907a1
-      X-Runtime:
-      - '0.090776'
-      Content-Length:
-      - '1569'
-      Connection:
-      - keep-alive
-    body:
-      encoding: ASCII-8BIT
-      string: !binary |-
-        H4sIAAAAAAAAA9VZ224bNxD9FUEvfQkT3i9+a5GiQIqgRa9Ag8IYkkNHjbQr
-        rNZOhcD/3llbvlQWmmkaAeqLIVM8u2fODmfOrD7M8Qq7cTM/e/Nhvqjzs3lI
-        0EzNWmDITtgERYBvUuhkfTAQolEwfzZ/O2Cj3S9u4S+YqHG7RkINWAh1DsOw
-        uIIlrZcBYcR6DuP8TFnllLJeS1rvu5F2zs+6y+WSbjqulud7a1uEYUNAWl+t
-        odverV9ucFpa3UY3DpdIl4Pubm1+1mC52a1V3IxDv73btlx07wjzYb4e+rZY
-        TowlKp+VNqKUaoRFK0VCqALA+mghqabbFMf9Dd/8/mx+i53oXF8/28mr0NJm
-        b0VMzgsbQiShihLgdFLVqYogn8rLRO3kha5bXOGwgWF7QFuZlLfxE7VVn1vY
-        6MAldCBUaEVYMEaAbE5AU7pVDCkGyxI262i9MVGUqKKwORmRPETRMEOC1HTI
-        B/KWifofCiu1DhEUCFsa0h8ZRI6AIitQIXqbnS8sYaFlk401QnmdhVUYKfWd
-        FFLZCilICZifCstE7YTNi2F8W+GAqjbqGNUplYLgDMgIXvhkqrAeSVhDyeOq
-        A9ukMyUrlrBap2p9NiLLRDUzRKqZoUiRm9HV5mKcck+FZaKYlZbw2kl3QvI2
-        4mNj8yIkQwUhUyeJaKswMsToTYktBZa86FwwPkVhkrFUWXITKZUmXKAWpX2l
-        0NNTeZkotrw+RnNK2VsaeBO0E9JqKWw0TtD5oipRXXJI9TYDr966EsFKH0Q0
-        ieAug8heJqFd0RkNOBMP1Fsmii+vT0qfkLxQJaYQlIgVpuzVKKItILQ2oNBR
-        j6u8qmujm5ofiuYwT+WbDAe5KAFWJZeihwr4VF4mitPObLDamk+tDPZzC1tb
-        cLJRK/FYyAFFp0Wy1NM09TOrgsnVIEtYU2XOgQxHdZEOuLMoICf6VFSrgU49
-        PaKnwjJR3Lz1E3f1idoeI29NKEkl1KKpMvkgyp6sqhVkgowvpVAR4+Vtdd5W
-        TfVFZ6mFlehExpiEw1hz8ipWdaDqMlF8eXXU4YTkbZaaszNITS3Q+FBcI+se
-        vKDAHNW9YJX0LHmRnkyVVQrTbrqjIqEUXag4rBR3M6kdamo8FFvemKQyJyRv
-        odpavFFCVU/yxlIFWV8rvLYpI3lPrLymlsgmA1JnakVSlfFVTTaLpoNQDHkP
-        mmbLgemMieLLG9xJyZuVAjK1VbQgJ6dAY35yNVF8TWpHY1rUPMdrPfXCmJ2o
-        eiriMtKcZ900mEztUrnW2qGmxkPx5aX8Panaizb6JKOoRpO8eTLz3oCYaqKj
-        CkgjkGPJm2yNpUzKaBq3LFbyrjTSCl3oDIRgvZf2QPbyUP9GXpdOSF6dtKa5
-        nqwCZHK8WAqN+IZqb1Mem6aR7aZ1f1xeH7EZk8mCwI0FmV7CGDoQpiBm48Bg
-        iU/lZaL+hbw0gZyQvC5YKZ2rwrtpHjXUYGheN6Ig9ZVAtiz6f85e+neFI0xX
-        HXCz7rsNfaWlPEx0WrtcV9Jk80C0v5xoK3f9iOGt/M/viX64k3i3spnT7t2m
-        h5vc77pfeti1d537i9xt/ci9dp+fL1ZwceA6O+5YH8m7eXgty5T5LvnW2K+X
-        +IKJavQgzjtYTXS+oqypm+V29rq87C/oyz/6fD4uxiXe/qUtP3fvuv59N3vV
-        59lPN2uPdN+F9/ejwzyDe+yZqKOzZxboPfZM1NHZM7v3Hnsm6ujsmdZujz0T
-        dXT2TN+/x56JOjp75lC4n/c81GP2r6n+b7bdCGVclNkvMCwg3/D7HFEwX8ns
-        RcFEHf0ZMN/X7ec/D3V09syXufv5z0MdnT3zR7899kzUY/bfYD9c4OyroS/v
-        lvj2ctiMB0P4stxYndnXf2K5HBdXjBB4vwLth8BDPQ7hFawWOPsNVm1BLq5c
-        fqZHwPyxZY8/E/WY//cwDovybvYSV+sNbg/S/wEvFn0Hy9mPQN5s9ho6Yjx8
-        NAbmq8u9GJioxzF8i8Ownf0Km7eL7mLsu4NB/Ni38T0MSJFe4bJfMwJg/ka7
-        FwAT9bdzALkfZt998fL99obWf8mg3w/NHDcfr6//Ag63iAb2IAAA
-    http_version: 
-  recorded_at: Tue, 04 Nov 2014 16:34:37 GMT
-recorded_with: VCR 2.9.3