namely 0.0.1

data/lib/namely/country.rb

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

data/lib/namely/currency_type.rb

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

data/lib/namely/event.rb

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

data/lib/namely/exceptions.rb

@@ -0,0 +1,13 @@
+module Namely
+  class Error < StandardError
+  end
+
+  class ImproperlyConfiguredError < Error
+  end
+
+  class NoSuchModelError < Error
+  end
+
+  class FailedRequestError < Error
+  end
+end

data/lib/namely/field.rb

@@ -0,0 +1,9 @@
+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

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

data/lib/namely/profile.rb

@@ -0,0 +1,13 @@
+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

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

data/lib/namely/resource_gateway.rb

@@ -0,0 +1,81 @@
+module Namely
+  class ResourceGateway
+    def initialize(options)
+      @access_token = options.fetch(:access_token)
+      @endpoint = options.fetch(:endpoint)
+      @resource_name = options.fetch(:resource_name)
+      @subdomain = options.fetch(:subdomain)
+    end
+
+    def json_index
+      get("/#{endpoint}", limit: :all)[resource_name]
+    end
+
+    def json_show(id)
+      get("/#{endpoint}/#{id}")[resource_name].first
+    end
+
+    def show_head(id)
+      head("/#{endpoint}/#{id}")
+    end
+
+    def create(attributes)
+      response = post(
+        "/#{endpoint}",
+        endpoint => [attributes]
+      )
+      extract_id(response)
+    end
+
+    def update(id, changes)
+      put("/#{endpoint}/#{id}", endpoint => [changes])
+    end
+
+    private
+
+    attr_reader :access_token, :endpoint, :resource_name, :subdomain
+
+    def url(path)
+      "https://#{subdomain}.namely.com/api/v1#{path}"
+    end
+
+    def extract_id(response)
+      JSON.parse(response)[endpoint].first["id"]
+    rescue StandardError => e
+      raise(
+        FailedRequestError,
+        "Couldn't parse \"id\" from response: #{e.message}"
+      )
+    end
+
+    def get(path, params = {})
+      params.merge!(access_token: access_token)
+      JSON.parse(RestClient.get(url(path), accept: :json, params: params))
+    end
+
+    def head(path, params = {})
+      params.merge!(access_token: access_token)
+      RestClient.head(url(path), accept: :json, params: params)
+    end
+
+    def post(path, params)
+      params.merge!(access_token: access_token)
+      RestClient.post(
+        url(path),
+        params.to_json,
+        accept: :json,
+        content_type: :json,
+      )
+    end
+
+    def put(path, params)
+      params.merge!(access_token: access_token)
+      RestClient.put(
+        url(path),
+        params.to_json,
+        accept: :json,
+        content_type: :json
+      )
+    end
+  end
+end

data/lib/namely/restful_model.rb

@@ -0,0 +1,150 @@
+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/lib/namely/version.rb

@@ -0,0 +1,3 @@
+module Namely
+  VERSION = "0.0.1"
+end

data/namely.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "namely/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "namely"
+  spec.version       = Namely::VERSION
+  spec.authors       = ["Harry Schwartz"]
+  spec.email         = ["harry@thoughtbot.com"]
+  spec.summary       = "Wraps the Namely HTTP API in lovely Ruby."
+  spec.homepage      = "https://github.com/namely/ruby-client"
+  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_dependency "backports"
+  spec.add_dependency "rest_client"
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "dotenv"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "vcr"
+  spec.add_development_dependency "webmock"
+  spec.add_development_dependency "yard"
+end

data/spec/fixtures/vcr_cassettes/country_head.yml

@@ -0,0 +1,51 @@
+---
+http_interactions:
+- request:
+    method: head
+    uri: https://<TEST_SUBDOMAIN>.namely.com/api/v1/countries/US?access_token=<TEST_ACCESS_TOKEN>
+    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:36 GMT
+      Server:
+      - nginx/1.6.2
+      Status:
+      - 200 OK
+      Strict-Transport-Security:
+      - max-age=31536000
+      - max-age=31536000; includeSubDomains;
+      Vary:
+      - Accept-Encoding
+      X-Rack-Cache:
+      - miss
+      X-Request-Id:
+      - 12b71052-a0c4-4776-86ee-417d8f3b87dd
+      X-Runtime:
+      - '0.021096'
+      Connection:
+      - keep-alive
+    body:
+      encoding: UTF-8
+      string: ''
+    http_version: 
+  recorded_at: Tue, 04 Nov 2014 16:34:36 GMT
+recorded_with: VCR 2.9.3

data/spec/fixtures/vcr_cassettes/country_head_missing.yml

@@ -0,0 +1,50 @@
+---
+http_interactions:
+- request:
+    method: head
+    uri: https://<TEST_SUBDOMAIN>.namely.com/api/v1/countries/this-is-almost-certainly-not-the-id-of-any-model?access_token=<TEST_ACCESS_TOKEN>
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - application/json
+      Accept-Encoding:
+      - gzip, deflate
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 404
+      message: Not Found
+    headers:
+      Cache-Control:
+      - no-cache
+      Content-Encoding:
+      - gzip
+      Content-Type:
+      - application/json; charset=utf-8
+      Date:
+      - Tue, 04 Nov 2014 16:34:36 GMT
+      Server:
+      - nginx
+      Status:
+      - 404 Not Found
+      Strict-Transport-Security:
+      - max-age=31536000
+      Vary:
+      - Accept-Encoding
+      X-Rack-Cache:
+      - miss
+      X-Request-Id:
+      - 15c2c8fd-5244-48b7-9f18-040318b7e9ac
+      X-Runtime:
+      - '0.026183'
+      Connection:
+      - keep-alive
+    body:
+      encoding: UTF-8
+      string: ''
+    http_version: 
+  recorded_at: Tue, 04 Nov 2014 16:34:36 GMT
+recorded_with: VCR 2.9.3