codelocks 2.0.3 → 3.0.0.pre.beta

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b56ca4d592d78151d6941c5113aa819fd48199f4
-  data.tar.gz: 6a3e0cf5458c5dc17f98b90c9206ddca89c6f294
+  metadata.gz: d12d67e7bf9e7e0cb6597b6b551599635c426095
+  data.tar.gz: 0e7c79bf2018b276d820337d005f44ebfa4cc567
 SHA512:
-  metadata.gz: d43e6324ed62dd083e100ccb991655faea32bf5e0080058bec8478c564c7673c678b2415091c536bd0929c970a76595dbe79a96f7a0219e325b9981984faaed6
-  data.tar.gz: edd987ac627764721afd6556850b912b27c23467d371b68121ba04c5b32a9b939d8f791044ab047e7732bf8ab855641e0a1cd28836e924b94f0a66e3e5f3b871
+  metadata.gz: 63038db7974ae0fc0bc9137b98a2d4c056945d0ff825e48db06daaabaf44d6c4cb43ea2f8027bd69f17bcb75e8ef367b1f6e2d7354b1ec6467d5b73a8b4150ed
+  data.tar.gz: d0e3dcfca9d37e0c7df4741a9315cf7cb1563bd46ce0d275f01a5d67c41dd6a6203dd1fc99b02c144f7c38980ac4f2f319f4ec6cf05011106fb9034943c6ae5d

data/.env.test

@@ -0,0 +1,3 @@
+CODELOCKS_BASE_URI=http://placeholder.com
+CODELOCKS_API_KEY=placeholder_api_key
+CODELOCKS_ACCESS_KEY=placeholder_access_key

data/.ruby-version

@@ -1 +1 @@
-ruby-2.2.3
+ruby-2.4.1

data/Gemfile

@@ -1,5 +1,5 @@
 source 'https://rubygems.org'
-ruby '2.2.3'
+ruby '2.4.1'
 
 # Specify your gem's dependencies in codelocks.gemspec
 gemspec

data/README.md

@@ -45,6 +45,16 @@ Codelocks.access_key = "argh"
 
 API documentation with information on methods is [available on RubyDoc.info](http://www.rubydoc.info/github/kansohq/codelocks/master).
 
+## Tests
+
+The test suite can be run locally using the following commands:
+
+```
+$ cp .env.test .env
+$ dotenv
+$ bundle exec rspec
+```
+
 ## Contributing
 
 1. Fork it ( https://github.com/[my-github-username]/codelocks/fork )

data/codelocks.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |spec|
   spec.name          = "codelocks"
   spec.version       = Codelocks::VERSION
   spec.authors       = ["Robert May"]
-  spec.email         = ["robert@kanso.io"]
+  spec.email         = ["rob@piratestudios.co.uk"]
   spec.summary       = %q{A simple API wrapper for the CodeLocks API}
   spec.description   = %q{A wrapper for the CodeLocks NetCode API used to generate lock codes.}
   spec.homepage      = "http://www.codelocks.co.uk"

data/lib/codelocks.rb

@@ -1,6 +1,9 @@
 require "faraday"
 
 require "codelocks/version"
+require "codelocks/client"
+require "codelocks/collection_proxy"
+require "codelocks/model"
 require "codelocks/request"
 require "codelocks/response"
 require "codelocks/lock"
@@ -8,45 +11,4 @@ require "codelocks/net_code"
 
 module Codelocks
   class CodelocksError < StandardError; end
-
-  class << self
-    attr_writer :base_uri, :api_key, :access_key
-
-    # The base URI used for API request
-    #
-    # @return [String] the base URI
-
-    def base_uri
-      @base_uri || ENV['CODELOCKS_BASE_URI'] || (raise CodelocksError.new("No base URI specified"))
-    end
-
-    # Return the configured API key or raise an exception
-    #
-    # @return [String] the API key
-
-    def api_key
-      @api_key || ENV['CODELOCKS_API_KEY'] || (raise CodelocksError.new("No API key specified"))
-    end
-
-    # Return the access key. This is tied to the K3 Connect App.
-    # This can be nil, as for certain models of locks you will provide a 6 digit ID instead.
-    #
-    # @return [String] the access key
-
-    def access_key
-      @access_key || ENV['CODELOCKS_ACCESS_KEY']
-    end
-
-    # Faraday connection object
-    #
-    # @return [Faraday]
-
-    def connection
-      @connection ||= Faraday.new(url: base_uri) do |faraday|
-        faraday.request  :url_encoded
-        faraday.response :logger
-        faraday.adapter  Faraday.default_adapter
-      end
-    end
-  end
 end

data/lib/codelocks/client.rb

@@ -0,0 +1,82 @@
+module Codelocks
+  class Client
+    attr_writer :base_uri, :api_key, :access_key
+
+    # The base URI used for API request
+    #
+    # @return [String] the base URI
+
+    def base_uri
+      @base_uri || ENV['CODELOCKS_BASE_URI'] || (raise CodelocksError.new("No base URI specified"))
+    end
+
+    # Return the configured API key or raise an exception
+    #
+    # @return [String] the API key
+
+    def api_key
+      @api_key || ENV['CODELOCKS_API_KEY'] || (raise CodelocksError.new("No API key specified"))
+    end
+
+    # Return the access key. This is tied to the K3 Connect App.
+    # This can be nil, as for certain models of locks you will provide a 6 digit ID instead.
+    #
+    # @return [String] the access key
+
+    def access_key
+      @access_key || ENV['CODELOCKS_ACCESS_KEY']
+    end
+
+    # Faraday connection object
+    #
+    # @return [Faraday]
+
+    def connection
+      @connection ||= Faraday.new(url: base_uri) do |faraday|
+        faraday.request  :url_encoded
+        faraday.response :logger
+        faraday.adapter  Faraday.default_adapter
+      end
+    end
+
+    # Set configuration variables on instantiation
+    #
+    # @return [Codelocks::Client]
+
+    def initialize(attributes = {})
+      attributes.each do |key, val|
+        setter = :"#{key}="
+
+        if respond_to?(setter)
+          send(setter, val)
+        end
+      end
+
+      self
+    end
+
+    # Proxy for the requests model
+    #
+    # @return [CollectionProxy]
+
+    def requests
+      @request_collection ||= CollectionProxy.new(model: Request, client: self)
+    end
+
+    # Proxy for the netcodes model
+    #
+    # @return [CollectionProxy]
+
+    def net_codes
+      @net_code_collection ||= CollectionProxy.new(model: NetCode, client: self)
+    end
+
+    # Proxy for the locks model
+    #
+    # @return [CollectionProxy]
+
+    def locks
+      @lock_collection ||= CollectionProxy.new(model: Lock, client: self)
+    end
+  end
+end

data/lib/codelocks/collection_proxy.rb

@@ -0,0 +1,26 @@
+module Codelocks
+  class CollectionProxy
+    extend Forwardable
+
+    # @return [Client]
+    attr_accessor :client
+
+    # @return [Lock, NetCode, Request]
+    attr_accessor :model
+
+    def_delegators :@model, :create, :all
+
+    # Set configuration variables on instantiation
+    #
+    # @return [Codelocks::CollectionProxy]
+
+    def initialize(client: nil, model: nil)
+      self.client = client
+      self.model = model
+
+      model.collection_proxy = self
+
+      self
+    end
+  end
+end

data/lib/codelocks/lock.rb

@@ -1,17 +1,15 @@
 module Codelocks
-  class Lock
+  class Lock < Model
     class << self
       # Fetch a list of locks. Requires the access key env var to be set
       #
       # @return [Codelocks::NetCode::Response]
 
       def all
-        if !Codelocks.access_key
-          raise CodelocksError.new("An access key must be provided")
-        end
+        super
 
-        Request.create("lock",
-          "accesskey": Codelocks.access_key
+        client.requests.create("lock",
+          "accesskey": client.access_key
         )
       end
     end

data/lib/codelocks/model.rb

@@ -0,0 +1,29 @@
+module Codelocks
+  class Model
+    extend Forwardable
+
+    # @return [Client]
+
+    def client
+      self.class.client
+    end
+
+    class << self
+      extend Forwardable
+
+      # @return [CollectionProxy]
+      attr_accessor :collection_proxy
+
+      def_delegator :@collection_proxy, :client
+
+      def all
+        if !client.access_key
+          raise CodelocksError.new("An access key must be provided")
+        end
+      end
+
+      def create
+      end
+    end
+  end
+end

data/lib/codelocks/net_code.rb

@@ -1,5 +1,5 @@
 module Codelocks
-  class NetCode
+  class NetCode < Model
     class << self
       # Predefined method for generating a new NetCode
       #
@@ -12,14 +12,14 @@ module Codelocks
       #
       # @return [Codelocks::NetCode::Response]
 
-      def generate_netcode(opts = {})
+      def create(opts = {})
         netcode = new(opts)
 
         if !netcode.identifier
           raise CodelocksError.new("Either a lock identifier or an access key must be provided")
         end
 
-        Request.create("netcode/#{netcode.lock_id}",
+        client.requests.create("netcode/#{netcode.lock_id}",
           "id": netcode.lock_id,
           "start": netcode.start_datetime,
           "duration": netcode.duration_id,
@@ -52,7 +52,7 @@ module Codelocks
     # @return [String]
 
     def identifier
-      opts[:identifier] || Codelocks.access_key
+      opts[:identifier] || client.access_key
     end
 
     # String representing the start date in YYYY-MM-DD format

data/lib/codelocks/request.rb

@@ -1,5 +1,5 @@
 module Codelocks
-  class Request
+  class Request < Model
     class << self
       # Perform a request against the NetCode API
       #
@@ -9,14 +9,15 @@ module Codelocks
       # @return [Codelocks::NetCode::Response]
 
       def create(path, params = {})
-        response = Codelocks.connection.get(path, default_params.merge(params)) do |req|
-          req.headers['x-api-key'] = Codelocks.api_key
+        response = client.connection.get(path, default_params.merge(params)) do |req|
+          req.headers['x-api-key'] = client.api_key
         end
 
         Response.new(response)
       end
 
       private
+
       # The default params used in NetCode endpoint requests
       #
       # @return [Hash]

data/lib/codelocks/version.rb

@@ -1,3 +1,3 @@
 module Codelocks
-  VERSION = "2.0.3"
+  VERSION = "3.0.0-beta"
 end

data/spec/codelocks/client_spec.rb

@@ -0,0 +1,92 @@
+require 'spec_helper'
+
+describe Codelocks::Client do
+  subject(:client) do
+    Codelocks::Client.new(
+      base_uri: ENV["CODELOCKS_BASE_URI"] || "wibble",
+      api_key: ENV["CODELOCKS_API_KEY"] || "wobble"
+    )
+  end
+
+  describe "#base_uri" do
+    subject { client.base_uri }
+
+    before { allow(ENV).to receive(:[]) { nil } }
+
+    context "is present" do
+      before { client.base_uri = "test" }
+
+      it { is_expected.to eq("test") }
+    end
+
+    context "is not present" do
+      before { client.base_uri = nil }
+
+      it "raises an exception" do
+        expect { subject }.to raise_error(Codelocks::CodelocksError)
+      end
+    end
+  end
+
+  describe "#api_key" do
+    subject { client.api_key }
+
+    before { allow(ENV).to receive(:[]) { nil } }
+
+    context "is present" do
+      before { client.api_key = "test" }
+
+      it { is_expected.to eq("test") }
+    end
+
+    context "is not present" do
+      before { client.api_key = nil }
+
+      it "raises an exception" do
+        expect { subject }.to raise_error(Codelocks::CodelocksError)
+      end
+    end
+  end
+
+  describe "#access_key" do
+    subject { client.access_key }
+
+    before { allow(ENV).to receive(:[]) { nil } }
+
+    context "is present" do
+      before { client.access_key = "test" }
+
+      it { is_expected.to eq("test") }
+    end
+
+    context "is not present" do
+      before { client.access_key = nil }
+
+      it { is_expected.to eq(nil) }
+    end
+  end
+
+  describe "#connection" do
+    subject { client.connection }
+
+    it { is_expected.to be_a(Faraday::Connection) }
+  end
+
+  describe "#requests" do
+    subject { client.requests }
+
+    it { is_expected.to be_a(Codelocks::CollectionProxy) }
+  end
+
+  describe "#net_codes" do
+    subject { client.net_codes }
+
+    it { is_expected.to be_a(Codelocks::CollectionProxy) }
+  end
+
+  describe "#locks" do
+    subject { client.locks }
+
+    it { is_expected.to be_a(Codelocks::CollectionProxy) }
+  end
+end

data/spec/codelocks/collection_proxy_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+
+describe Codelocks::CollectionProxy do
+  subject(:proxy) { Codelocks::CollectionProxy.new(model: model, client: client) }
+  let(:client) { Codelocks::Client.new }
+  let(:model) { Codelocks::Model }
+
+  describe "attribute accessors" do
+    [:client, :model].each do |attr|
+      it { is_expected.to respond_to(attr) }
+      it { is_expected.to respond_to(:"#{attr}=") }
+    end
+  end
+
+  describe "#initialize" do
+    subject { proxy.send(:initialize, client: client, model: model) }
+
+    after { subject }
+
+    it "sets the client" do
+      expect(proxy).to receive(:client=).with(client)
+    end
+
+    it "sets the model" do
+      expect(proxy).to receive(:model=).with(model)
+    end
+
+    it "sets itself as the model's proxy" do
+      expect(model).to receive(:collection_proxy=).with(proxy)
+    end
+  end
+end

data/spec/codelocks/lock_spec.rb

@@ -1,17 +1,19 @@
 require "spec_helper"
 
 describe Codelocks::Lock do
-  describe ".all" do
-    subject { Codelocks::Lock.all }
+  let(:client) do
+    Codelocks::Client.new(
+      base_uri: ENV["CODELOCKS_BASE_URI"] || "wibble",
+      api_key: ENV["CODELOCKS_API_KEY"] || "wobble"
+    )
+  end
 
-    before do
-      Codelocks.base_uri = ENV["CODELOCKS_BASE_URI"] || "wibble"
-      Codelocks.api_key = ENV["CODELOCKS_API_KEY"] || "wobble"
-    end
+  describe ".all" do
+    subject { client.locks.all }
 
     context "valid access key" do
       before do
-        Codelocks.access_key = ENV["CODELOCKS_ACCESS_KEY"] || "wubble"
+        client.access_key = ENV["CODELOCKS_ACCESS_KEY"] || "wubble"
       end
 
       around(:each) do |example|
@@ -33,7 +35,7 @@ describe Codelocks::Lock do
 
     context "invalid access key" do
       before do
-        Codelocks.access_key = "abracadabra"
+        client.access_key = "abracadabra"
       end
 
       around(:each) do |example|

data/spec/codelocks/model_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+
+describe Codelocks::Model do
+  let(:client) { Codelocks::Client.new }
+  let(:proxy) { Codelocks::CollectionProxy.new(model: Codelocks::Model, client: client) }
+
+  before do
+    Codelocks::Model.collection_proxy = proxy
+  end
+
+  describe "instance methods" do
+    subject(:model) { Codelocks::Model.new }
+
+    describe "#client" do
+      subject { model.client }
+
+      it { is_expected.to eq(client) }
+    end
+  end
+
+  describe "class methods" do
+    subject { Codelocks::Model }
+
+    describe ".all" do
+      it { is_expected.to respond_to(:all) }
+
+      context "access key isn't set" do
+        before { allow(client).to receive(:access_key) { nil } }
+
+        it "raises an error" do
+          expect { subject.all }.to raise_error(Codelocks::CodelocksError)
+        end
+      end
+    end
+
+    describe ".create" do
+      it { is_expected.to respond_to(:create) }
+    end
+  end
+end

data/spec/codelocks/net_code_spec.rb

@@ -1,18 +1,20 @@
 require "spec_helper"
 
 describe Codelocks::NetCode do
-  describe ".generate_netcode" do
+  let(:client) do
+    Codelocks::Client.new(
+      base_uri: ENV["CODELOCKS_BASE_URI"] || "wibble",
+      api_key: ENV["CODELOCKS_API_KEY"] || "wobble",
+      access_key: ENV["CODELOCKS_ACCESS_KEY"] || "wubble"
+    )
+  end
+
+  describe ".create" do
     let(:lock_id) { nil }
     let(:start_time) { Time.now }
     let(:duration) { 1 }
 
-    subject { Codelocks::NetCode.generate_netcode(lock_id: lock_id, start_time: start_time, duration: duration) }
-
-    before do
-      Codelocks.base_uri = ENV["CODELOCKS_BASE_URI"] || "wibble"
-      Codelocks.api_key = ENV["CODELOCKS_API_KEY"] || "wobble"
-      Codelocks.access_key = ENV["CODELOCKS_ACCESS_KEY"] || "wubble"
-    end
+    subject { client.net_codes.create(lock_id: lock_id, start_time: start_time, duration: duration) }
 
     context "valid lock ID" do
       let(:lock_id) { ENV["CODELOCKS_LOCK_ID"] || "valid" }

data/spec/codelocks/request_spec.rb

@@ -1,9 +1,11 @@
 require "spec_helper"
 
 describe Codelocks::Request do
-  before do
-    Codelocks.base_uri = "http://wobble.com/"
-    Codelocks.api_key = "wibble"
+  let(:client) do
+    Codelocks::Client.new(
+      base_uri: ENV["CODELOCKS_BASE_URI"] || "wibble",
+      api_key: ENV["CODELOCKS_API_KEY"] || "wobble"
+    )
   end
 
   describe "#create" do
@@ -21,19 +23,19 @@ describe Codelocks::Request do
     let(:path) { "netcode/#{params[:id]}" }
 
     before do
-      allow(Codelocks.connection).to receive(:get) { response }
-      allow(Codelocks::Request).to receive(:default_params) { default_params }
+      allow(client.connection).to receive(:get) { response }
+      allow(client.requests.model).to receive(:default_params) { default_params }
     end
 
 
     it "performs a get request" do
-      expect(Codelocks.connection).to receive(:get).with(path, all_params)
-      Codelocks::Request.create(path, params)
+      expect(client.connection).to receive(:get).with(path, all_params)
+      client.requests.create(path, params)
     end
 
     it "returns a response object" do
       expect(
-        Codelocks::Request.create(path, params)
+        client.requests.create(path, params)
       ).to be_a(Codelocks::Response)
     end
   end

data/spec/codelocks/response_spec.rb

@@ -1,14 +1,16 @@
 require "spec_helper"
 
 describe Codelocks::Response do
+  let(:client) do
+    Codelocks::Client.new(
+      base_uri: ENV["CODELOCKS_BASE_URI"] || "wibble",
+      api_key: ENV["CODELOCKS_API_KEY"] || "wobble"
+    )
+  end
+
   let(:response) { Codelocks::Response.new(faraday_response) }
   let(:faraday_response) { double('faraday_response', success?: true, body: '{"test": "thing"}') }
 
-  before do
-    Codelocks.base_uri = "http://wobble.com/"
-    Codelocks.api_key = "wibble"
-  end
-
   describe "#initialize" do
     it "sets the response instance variable" do
       expect(response.response).to eq(faraday_response)

data/spec/codelocks_spec.rb

@@ -1,68 +1,4 @@
 require "spec_helper"
 
 describe Codelocks do
-  describe "#base_uri" do
-    subject { Codelocks.base_uri }
-
-    before { allow(ENV).to receive(:[]) { nil } }
-
-    context "is present" do
-      before { Codelocks.base_uri = "test" }
-
-      it { is_expected.to eq("test") }
-    end
-
-    context "is not present" do
-      before { Codelocks.base_uri = nil }
-
-      it "raises an exception" do
-        expect { subject }.to raise_error(Codelocks::CodelocksError)
-      end
-    end
-  end
-
-  describe "#api_key" do
-    subject { Codelocks.api_key }
-
-    before { allow(ENV).to receive(:[]) { nil } }
-
-    context "is present" do
-      before { Codelocks.api_key = "test" }
-
-      it { is_expected.to eq("test") }
-    end
-
-    context "is not present" do
-      before { Codelocks.api_key = nil }
-
-      it "raises an exception" do
-        expect { subject }.to raise_error(Codelocks::CodelocksError)
-      end
-    end
-  end
-
-  describe "#access_key" do
-    subject { Codelocks.access_key }
-
-    before { allow(ENV).to receive(:[]) { nil } }
-
-    context "is present" do
-      before { Codelocks.access_key = "test" }
-
-      it { is_expected.to eq("test") }
-    end
-
-    context "is not present" do
-      before { Codelocks.access_key = nil }
-
-      it { is_expected.to eq(nil) }
-    end
-  end
-
-
-  describe "#connection" do
-    subject { Codelocks.connection }
-
-    it { is_expected.to be_a(Faraday::Connection) }
-  end
 end

data/spec/spec_helper.rb

@@ -8,8 +8,8 @@ require "pry"
 VCR.configure do |config|
   config.cassette_library_dir = "spec/fixtures/vcr_cassettes"
   config.hook_into :faraday
-  config.filter_sensitive_data("<BASE_URI>") { Codelocks.base_uri }
-  config.filter_sensitive_data("<API_KEY>") { Codelocks.api_key }
-  config.filter_sensitive_data("<ACCESS_KEY>") { Codelocks.access_key }
+  config.filter_sensitive_data("<BASE_URI>") { ENV['CODELOCKS_BASE_URI'] }
+  config.filter_sensitive_data("<API_KEY>") { ENV['CODELOCKS_API_KEY'] }
+  config.filter_sensitive_data("<ACCESS_KEY>") { ENV['CODELOCKS_ACCESS_KEY'] }
   config.filter_sensitive_data("LOCK_ID") { ENV['CODELOCKS_LOCK_ID'] }
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: codelocks
 version: !ruby/object:Gem::Version
-  version: 2.0.3
+  version: 3.0.0.pre.beta
 platform: ruby
 authors:
 - Robert May
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-17 00:00:00.000000000 Z
+date: 2017-11-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -110,11 +110,12 @@ dependencies:
         version: '0.9'
 description: A wrapper for the CodeLocks NetCode API used to generate lock codes.
 email:
-- robert@kanso.io
+- rob@piratestudios.co.uk
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".env.test"
 - ".gitignore"
 - ".ruby-version"
 - Gemfile
@@ -123,12 +124,18 @@ files:
 - Rakefile
 - codelocks.gemspec
 - lib/codelocks.rb
+- lib/codelocks/client.rb
+- lib/codelocks/collection_proxy.rb
 - lib/codelocks/lock.rb
+- lib/codelocks/model.rb
 - lib/codelocks/net_code.rb
 - lib/codelocks/request.rb
 - lib/codelocks/response.rb
 - lib/codelocks/version.rb
+- spec/codelocks/client_spec.rb
+- spec/codelocks/collection_proxy_spec.rb
 - spec/codelocks/lock_spec.rb
+- spec/codelocks/model_spec.rb
 - spec/codelocks/net_code_spec.rb
 - spec/codelocks/request_spec.rb
 - spec/codelocks/response_spec.rb
@@ -153,17 +160,20 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: A simple API wrapper for the CodeLocks API
 test_files:
+- spec/codelocks/client_spec.rb
+- spec/codelocks/collection_proxy_spec.rb
 - spec/codelocks/lock_spec.rb
+- spec/codelocks/model_spec.rb
 - spec/codelocks/net_code_spec.rb
 - spec/codelocks/request_spec.rb
 - spec/codelocks/response_spec.rb
@@ -173,4 +183,3 @@ test_files:
 - spec/fixtures/vcr_cassettes/valid_access_key.yml
 - spec/fixtures/vcr_cassettes/valid_lock_id.yml
 - spec/spec_helper.rb
-has_rdoc: