codelocks 1.0.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 22a32b897d94688bf6f6a455987b58f0c05d251c
-  data.tar.gz: 7c58c530ddc5ea411222c82d0f66b95e286b3e51
+  metadata.gz: 95679230c6136305c9e70650b31100d9d53bcc54
+  data.tar.gz: 7a4e35c3bc4d007e93bd3254a174b933db9b6126
 SHA512:
-  metadata.gz: e8860b06e8c2b86a4a5f388b3e9d57a9ffb5b8ea2de4e36ec897f5f793a019d9a9ca05d9cfb8129c010a1dbd9df4ac4035d3c27bcff34d410c6dacbccd4e1ace
-  data.tar.gz: 6ac150201dfc62c9cefc77a88dd8bab938b0405c63cc28f7b66436bf66a540240768553842e2c11ced71a20c04bfb34891fb8d3219b77c4d4c48e6386ce07fa9
+  metadata.gz: 2a61b480d8b59951b11130b39df8976a8d1311becd4cf460f347def4a1f74b8f6ce080e0d54d0c4c10e3cf50383e44311fc123e744fd3b59ac558cc8245f6343
+  data.tar.gz: 762f6fc396ffbe55806698dd3405f94912b7a675ef16f5377d232b6ac4971132af86ddcbbe7a7548ada89ee9a99aed730f467a6732cac56543dd0b7751847aa8

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.2.3

data/README.md

@@ -1,9 +1,14 @@
 # Codelocks
 
-[![Circle CI](https://circleci.com/gh/kansohq/codelocks.svg?style=svg)](https://circleci.com/gh/kansohq/codelocks)
+[![Gem Version](https://badge.fury.io/rb/codelocks.svg)](https://badge.fury.io/rb/codelocks)
 
 A simple gem to wrap the Codelocks NetCode API, for generating key codes to operate their physical locks.
 
+# API Versions
+
+If you are using an API version prior to v4.1, you need to use the latest v1 release of this gem.
+v2 is a large rewrite in order to support the new API.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -25,15 +30,17 @@ Or install it yourself as:
 Configure your API credentials, either by setting the following two environment variables:
 
 ```
+CODELOCKS_BASE_URI
 CODELOCKS_API_KEY
-CODELOCKS_PAIRING_ID
+CODELOCKS_ACCESS_KEY
 ```
 
 Or by setting them directly in Ruby:
 
 ```ruby
+Codelocks.base_uri = "http://something.com"
 Codelocks.api_key = "blargh"
-Codelocks.pairing_id = "argh"
+Codelocks.access_key = "argh"
 ```
 
 API documentation with information on methods is [available on RubyDoc.info](http://www.rubydoc.info/github/kansohq/codelocks/master).

data/codelocks.gemspec

@@ -23,6 +23,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rspec", "~> 3.3"
   spec.add_development_dependency "vcr", "~> 2.9"
   spec.add_development_dependency "dotenv", "~> 2.0"
+  spec.add_development_dependency "pry"
 
   spec.add_dependency "faraday", "~> 0.8.11"
 

data/lib/codelocks.rb

@@ -1,22 +1,23 @@
 require "faraday"
 
 require "codelocks/version"
+require "codelocks/request"
+require "codelocks/response"
+require "codelocks/lock"
 require "codelocks/net_code"
-require "codelocks/net_code/request"
-require "codelocks/net_code/response"
 
 module Codelocks
   class CodelocksError < StandardError; end
 
   class << self
-    attr_writer :api_key, :pairing_id
+    attr_writer :base_uri, :api_key, :access_key
 
     # The base URI used for API request
     #
     # @return [String] the base URI
 
     def base_uri
-      "https://api-2445581366752.apicast.io/api/v3"
+      @base_uri || ENV['CODELOCKS_BASE_URI'] || (raise CodelocksError.new("No base URI specified"))
     end
 
     # Return the configured API key or raise an exception
@@ -27,12 +28,13 @@ module Codelocks
       @api_key || ENV['CODELOCKS_API_KEY'] || (raise CodelocksError.new("No API key specified"))
     end
 
-    # Return the configured pairing ID or raise an exception
+    # 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 pairing ID
+    # @return [String] the access key
 
-    def pairing_id
-      @pairing_id || ENV['CODELOCKS_PAIRING_ID'] || (raise CodelocksError.new("No pairing ID specified"))
+    def access_key
+      @access_key || ENV['CODELOCKS_ACCESS_KEY']
     end
 
     # Faraday connection object

data/lib/codelocks/lock.rb

@@ -0,0 +1,19 @@
+module Codelocks
+  class Lock
+    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
+
+        Request.create("lock",
+          "accesskey": Codelocks.access_key
+        )
+      end
+    end
+  end
+end

data/lib/codelocks/net_code.rb

@@ -1,54 +1,142 @@
 module Codelocks
-  module NetCode
+  class NetCode
     class << self
       # Predefined method for generating a new NetCode
       #
       # @option [String] :lock_id The lock identifier
-      # @option [Time] :start_time (Time.now) The start datetime object
-      # @option [Integer] :duration The number of hours the generated code should be valid for from the start_time
+      # @option [String] :lock_model (K3CONNECT) The type of lock
+      # @option [Time] :start (Time.now) The start datetime object
+      # @option [Integer] :duration (0) The number of hours the generated code should be valid for from the start_time
+      # @option [Boolean] :urm (false) Generate an URM code
+      # @option [String] :identifier (Codelocks.access_key) The access key or lock identifier
       #
       # @return [Codelocks::NetCode::Response]
 
-      def generate_netcode(lock_id: nil, start_time: Time.now, duration: nil)
-        Request.create("netcode/ncgenerator/getnetcode", {
-          id: "N#{lock_id}",
-          sd: start_time.strftime("%d/%m/%Y"),
-          st: start_time.strftime("%H"),
-          du: convert_duration(duration)
-        })
+      def generate_netcode(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}",
+          "id": netcode.lock_id,
+          "start": netcode.start_datetime,
+          "duration": netcode.duration_id,
+          "lockmodel": netcode.lock_model,
+          "identifier": netcode.identifier
+        )
       end
+    end
 
-      private
+    attr_accessor :opts
 
-      # Convert a duration in hours to the NetCode duration option
-      #
-      # @param [Integer] duration number of hours duration
-      #
-      # @return [Integer]
-
-      def convert_duration(duration = 0)
-        case
-        when duration == 0
-          duration
-        when duration <= 12 # less than 13 hours
-          duration -1
-        when (13..24).include?(duration) # 1 day
-          12
-        when (25..48).include?(duration) # 2 days
-          13
-        when (49..72).include?(duration) # 3 days
-          14
-        when (73..96).include?(duration) # 4 days
-          15
-        when (97..120).include?(duration) # 5 days
-          16
-        when (121..144).include?(duration) # 6 days
-          17
-        when (145..168).include?(duration) # 7 days
-          18
-        when duration > 168 # more than 7 days, generates a URM code
-          19
-        end
+    def initialize(opts = {})
+      self.opts = {
+        lock_model: nil || "K3CONNECT",
+        lock_id: nil,
+        start: Time.now,
+        duration: 0,
+        urm: false,
+        identifier: nil
+      }.merge(opts)
+    end
+
+    def method_missing(method, *args, &block)
+      return opts[method] if opts.include?(method)
+      super
+    end
+
+    # Return either a supplied identifier or the predefined access key
+    #
+    # @return [String]
+
+    def identifier
+      opts[:identifier] || Codelocks.access_key
+    end
+
+    # String representing the start date in YYYY-MM-DD format
+    #
+    # @return [String]
+
+    def start_date
+      start.strftime("%Y-%m-%d")
+    end
+
+    # String representing the start time. Hour has a leading zero
+    #
+    # @return [String]
+
+    def start_time
+      if urm? && duration_id >= 31 # URM enabled and >= 24 hours duration
+        "00:00"
+      else
+        start.strftime("%H:%M")
+      end
+    end
+
+    # Full date time formatted for API use
+    #
+    # @return [String]
+
+    def start_datetime
+      [start_date, start_time].join(" ")
+    end
+
+    # NetCode duration ID
+    #
+    # @return [Integer]
+
+    def duration_id
+      base_duration + urm_offset
+    end
+
+    # Are URM codes enabled?
+    #
+    # @return [Boolean]
+
+    def urm?
+      !!urm
+    end
+
+    private
+
+    # Convert a duration in hours to the NetCode duration ID
+    #
+    # @return [Integer]
+
+    def base_duration
+      case duration
+      when 0
+        0
+      when 1..12 # less than 13 hours
+        duration - 1
+      when 13..24 # 1 day
+        12
+      when 25..48 # 2 days
+        13
+      when 49..72 # 3 days
+        14
+      when 73..96 # 4 days
+        15
+      when 97..120 # 5 days
+        16
+      when 121..144 # 6 days
+        17
+      else # 7 days
+        18
+      end
+    end
+
+    # Convert a URM enabled boolean to a NetCode duration offset
+    #
+    # @return [Integer]
+
+    def urm_offset
+      if urm?
+        19
+      else
+        0
       end
     end
   end

data/lib/codelocks/request.rb

@@ -0,0 +1,29 @@
+module Codelocks
+  class Request
+    class << self
+      # Perform a request against the NetCode API
+      #
+      # @param [String] path the URI path to perform the request against
+      # @param [Hash] params defined in Codelocks::NetCode
+      #
+      # @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
+        end
+
+        Response.new(response)
+      end
+
+      private
+      # The default params used in NetCode endpoint requests
+      #
+      # @return [Hash]
+
+      def default_params
+        {}
+      end
+    end
+  end
+end

data/lib/codelocks/response.rb

@@ -0,0 +1,51 @@
+require "json"
+
+module Codelocks
+  class Response
+    attr_reader :response
+
+    # Initialize the response object
+    #
+    # @param [Faraday::Response] faraday_response
+
+    def initialize(faraday_response)
+      @response = faraday_response
+    end
+
+    # Was the request successful?
+    #
+    # @return [Truthy]
+
+    def success?
+      response.success?
+    end
+
+    # Parse the response from the server
+    #
+    # @return [Hash,Nil]
+
+    def body
+      @body ||= JSON.parse(response.body)
+    end
+
+    # Convenience method for fetching the error message
+    #
+    # @return [String]
+
+    def error_message
+      if !success?
+        body["Message"]
+      end
+    rescue JSON::ParserError => ex
+      ex.message
+    end
+
+    # Simple method missing accessor for reading returned attributes
+    #
+    # @return [String] the raw returned string from the API
+
+    def method_missing(method_name, *opts, &block)
+      body[method_name.to_s] if body.is_a?(Hash)
+    end
+  end
+end

data/lib/codelocks/version.rb

@@ -1,3 +1,3 @@
 module Codelocks
-  VERSION = "1.0.1"
+  VERSION = "2.0.0"
 end

data/spec/codelocks/lock_spec.rb

@@ -0,0 +1,52 @@
+require "spec_helper"
+
+describe Codelocks::Lock do
+  describe ".all" do
+    subject { Codelocks::Lock.all }
+
+    before do
+      Codelocks.base_uri = ENV["CODELOCKS_BASE_URI"] || "wibble"
+      Codelocks.api_key = ENV["CODELOCKS_API_KEY"] || "wobble"
+    end
+
+    context "valid access key" do
+      before do
+        Codelocks.access_key = ENV["CODELOCKS_ACCESS_KEY"] || "wubble"
+      end
+
+      around(:each) do |example|
+        VCR.use_cassette("valid_access_key", erb: true, match_requests_on: [:method]) do
+          example.run
+        end
+      end
+
+      it { is_expected.to be_a(Codelocks::Response) }
+
+      it "is successful" do
+        expect(subject.success?).to be true
+      end
+
+      it "doesn't return an error" do
+        expect(subject.error_message).to be nil
+      end
+    end
+
+    context "invalid access key" do
+      before do
+        Codelocks.access_key = "abracadabra"
+      end
+
+      around(:each) do |example|
+        VCR.use_cassette("invalid_access_key", erb: true, match_requests_on: [:method]) do
+          example.run
+        end
+      end
+
+      it { is_expected.to be_a(Codelocks::Response) }
+
+      it "returns an error" do
+        expect(subject.error_message).to be_a(String)
+      end
+    end
+  end
+end

data/spec/codelocks/net_code_spec.rb

@@ -1,7 +1,7 @@
 require "spec_helper"
 
 describe Codelocks::NetCode do
-  describe "#generate_netcode" do
+  describe ".generate_netcode" do
     let(:lock_id) { nil }
     let(:start_time) { Time.now }
     let(:duration) { 1 }
@@ -9,12 +9,13 @@ describe Codelocks::NetCode do
     subject { Codelocks::NetCode.generate_netcode(lock_id: lock_id, start_time: start_time, duration: duration) }
 
     before do
-      Codelocks.api_key = ENV['CODELOCKS_API_KEY'] || "wibble"
-      Codelocks.pairing_id = ENV['CODELOCKS_PAIRING_ID'] || "wobble"
+      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
 
     context "valid lock ID" do
-      let(:lock_id) { ENV['CODELOCKS_LOCK_ID'] || "valid" }
+      let(:lock_id) { ENV["CODELOCKS_LOCK_ID"] || "valid" }
 
       around(:each) do |example|
         VCR.use_cassette("valid_lock_id", erb: true, match_requests_on: [:method]) do
@@ -22,22 +23,22 @@ describe Codelocks::NetCode do
         end
       end
 
-      it { is_expected.to be_a(Codelocks::NetCode::Response) }
+      it { is_expected.to be_a(Codelocks::Response) }
 
       it "is successful" do
         expect(subject.success?).to be true
       end
 
       it "returns a valid netcode" do
-        expect(subject.netcode).to be_a(String)
+        expect(subject.ActualNetcode).to be_a(String)
       end
 
       it "returns a valid starttime" do
-        expect(subject.starttime).to be_a(String)
+        expect(subject.Startdate).to be_a(String)
       end
 
       it "doesn't return an error" do
-        expect(subject.error).to be nil
+        expect(subject.error_message).to be nil
       end
     end
 
@@ -50,28 +51,138 @@ describe Codelocks::NetCode do
         end
       end
 
-      it { is_expected.to be_a(Codelocks::NetCode::Response) }
+      it { is_expected.to be_a(Codelocks::Response) }
 
-      it "returns an error" do
-        expect(subject.error).to be_a(String)
+      it "returns an error message" do
+        expect(subject.error_message).to be_a(String)
       end
+    end
+  end
 
-      it "returns an error message" do
-        expect(subject.message).to be_a(String)
+  let(:lock_id) { "001" }
+  let(:start) { Time.new(2016, 1, 1, 14, 0, 0) }
+  let(:duration) { 0 }
+  let(:urm) { false }
+
+  subject(:netcode) { Codelocks::NetCode.new(lock_id: lock_id, start: start, duration: duration, urm: urm) }
+
+  describe "#start_date" do
+    subject { netcode.start_date }
+    it { is_expected.to eq "2016-01-01" }
+  end
+
+  describe "#start_time" do
+    subject { netcode.start_time }
+
+    context "URM disabled and any duration ID" do
+      let(:urm) { false }
+      before { allow(netcode).to receive(:duration_id) { 31 } }
+      it { is_expected.to eq "14:00" }
+    end
+
+    context "URM enabled and duration ID under 31" do
+      let(:urm) { true }
+      before { allow(netcode).to receive(:duration_id) { 30 } }
+      it { is_expected.to eq "14:00" }
+    end
+
+    context "URM enabled and duration ID over 30" do
+      let(:urm) { true }
+      before { allow(netcode).to receive(:duration_id) { 31 } }
+      it { is_expected.to eq "00:00" }
+    end
+  end
+
+  describe "#start_datetime" do
+    subject { netcode.start_datetime }
+    it { is_expected.to eq("2016-01-01 14:00") }
+  end
+
+  describe "#duration_id" do
+    context "URM disabled" do
+      let(:urm) { false }
+
+      context "zero duration" do
+        it "return 0" do
+          allow(netcode).to receive(:duration) { 0 }
+          expect(netcode.duration_id).to eq 0
+        end
+      end
+
+      context "up to half a day" do
+        it "returns minus one from the duration" do
+          (1..12).each do |i|
+            allow(netcode).to receive(:duration) { i }
+            expect(netcode.duration_id).to eq i - 1
+          end
+        end
+      end
+
+      context "whole days" do
+        it "returns number of days counting from 11" do
+          (1..7).each do |i|
+            allow(netcode).to receive(:duration) { i * 24 }
+            expect(netcode.duration_id).to eq 11 + i
+          end
+        end
+      end
+
+      context "over 7 days" do
+        it "returns 18" do
+          allow(netcode).to receive(:duration) { 8 * 24 }
+          expect(netcode.duration_id).to eq 18
+        end
+      end
+    end
+
+    context "URM enabled" do
+      let(:urm) { true }
+
+      context "zero duration" do
+        it "return 19" do
+          allow(netcode).to receive(:duration) { 0 }
+          expect(netcode.duration_id).to eq 19
+        end
+      end
+
+      context "up to half a day" do
+        it "returns 19 minus one from the duration" do
+          (1..12).each do |i|
+            allow(netcode).to receive(:duration) { i }
+            expect(netcode.duration_id).to eq 19 + i - 1
+          end
+        end
+      end
+
+      context "whole days" do
+        it "returns number of days counting from 30" do
+          (1..7).each do |i|
+            allow(netcode).to receive(:duration) { i * 24 }
+            expect(netcode.duration_id).to eq 19 + 11 + i
+          end
+        end
+      end
+
+      context "over 7 days" do
+        it "returns 37" do
+          allow(netcode).to receive(:duration) { 8 * 24 }
+          expect(netcode.duration_id).to eq 19 + 18
+        end
       end
     end
   end
 
-  describe '#convert_duration' do
-    subject { Codelocks::NetCode.send(:convert_duration, duration) }
-    let(:duration) { rand(0..1000) }
+  describe "#urm?" do
+    subject { netcode.urm? }
 
-    it "doesn't return an error" do
-      expect { subject }.not_to raise_error
+    context "URM disabled" do
+      let(:urm) { false }
+      it { is_expected.to eq false }
     end
 
-    it "returns an integer" do
-      expect(subject).to be_a(Integer)
+    context "URM enabled" do
+      let(:urm) { true }
+      it { is_expected.to eq true }
     end
   end
 end

data/spec/codelocks/{net_code/request_spec.rb → request_spec.rb}

@@ -1,44 +1,40 @@
 require "spec_helper"
 
-describe Codelocks::NetCode::Request do
+describe Codelocks::Request do
   before do
+    Codelocks.base_uri = "http://wobble.com/"
     Codelocks.api_key = "wibble"
-    Codelocks.pairing_id = "wobble"
   end
 
   describe "#create" do
-    let(:response) { double('faraday_response') }
-    let(:path) { "netcode/ncgenerator/getnetcode" }
     let(:params) do
-      {
-        id: "lock"
-      }
+      { id: "lock" }
     end
 
     let(:default_params) do
-      {
-        api_key: "wibble",
-        pairing_id: "wobble"
-      }
+      {}
     end
 
     let(:all_params) { default_params.merge(params) }
 
+    let(:response) { double('faraday_response') }
+    let(:path) { "netcode/#{params[:id]}" }
+
     before do
       allow(Codelocks.connection).to receive(:get) { response }
-      allow(Codelocks::NetCode::Request).to receive(:default_params) { default_params }
+      allow(Codelocks::Request).to receive(:default_params) { default_params }
     end
 
 
     it "performs a get request" do
       expect(Codelocks.connection).to receive(:get).with(path, all_params)
-      Codelocks::NetCode::Request.create(path, params)
+      Codelocks::Request.create(path, params)
     end
 
     it "returns a response object" do
       expect(
-        Codelocks::NetCode::Request.create(path, params)
-      ).to be_a(Codelocks::NetCode::Response)
+        Codelocks::Request.create(path, params)
+      ).to be_a(Codelocks::Response)
     end
   end
 end

data/spec/codelocks/{net_code/response_spec.rb → response_spec.rb}

@@ -1,12 +1,12 @@
 require "spec_helper"
 
-describe Codelocks::NetCode::Response do
-  let(:response) { Codelocks::NetCode::Response.new(faraday_response) }
+describe Codelocks::Response do
+  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"
-    Codelocks.pairing_id = "wobble"
   end
 
   describe "#initialize" do
@@ -33,18 +33,11 @@ describe Codelocks::NetCode::Response do
 
   describe "#body" do
     subject { response.body }
+    it { is_expected.to be_a(Hash) }
+  end
 
-    context "success? is true" do
-      before { allow(faraday_response).to receive(:success?) { true } }
-
-      it { is_expected.to be_a(Hash) }
-    end
-
-    context "success? is false" do
-      before { allow(faraday_response).to receive(:success?) { false } }
-
-      it { is_expected.to be nil }
-    end
+  describe "#error_message" do
+    #TODO
   end
 
   describe "#method_missing" do

data/spec/codelocks_spec.rb

@@ -4,7 +4,21 @@ describe Codelocks do
   describe "#base_uri" do
     subject { Codelocks.base_uri }
 
-    it { is_expected.to be_a(String) }
+    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
@@ -27,26 +41,25 @@ describe Codelocks do
     end
   end
 
-  describe "#pairing_id" do
-    subject { Codelocks.pairing_id }
+  describe "#access_key" do
+    subject { Codelocks.access_key }
 
     before { allow(ENV).to receive(:[]) { nil } }
 
     context "is present" do
-      before { Codelocks.pairing_id = "test" }
+      before { Codelocks.access_key = "test" }
 
       it { is_expected.to eq("test") }
     end
 
     context "is not present" do
-      before { Codelocks.pairing_id = nil }
+      before { Codelocks.access_key = nil }
 
-      it "raises an exception" do
-        expect { subject }.to raise_error(Codelocks::CodelocksError)
-      end
+      it { is_expected.to eq(nil) }
     end
   end
 
+
   describe "#connection" do
     subject { Codelocks.connection }
 

data/spec/fixtures/vcr_cassettes/invalid_access_key.yml

@@ -0,0 +1,40 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: "<BASE_URI>/lock?accesskey=<ACCESS_KEY>"
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v0.9.2
+      x-api-key:
+      - "<API_KEY>"
+  response:
+    status:
+      code: 401
+      message: 
+    headers:
+      content-type:
+      - application/json
+      content-length:
+      - '0'
+      connection:
+      - close
+      date:
+      - Thu, 26 May 2016 12:25:28 GMT
+      x-amzn-requestid:
+      - ee1e1ebc-233c-11e6-90fb-e7ebd021b93a
+      x-cache:
+      - Error from cloudfront
+      via:
+      - 1.1 b24665a554e30571f85b913251577ced.cloudfront.net (CloudFront)
+      x-amz-cf-id:
+      - 1JTnbI60plpNMGMqU_lc7t2jr03ZA6qd65GjG7VjBFI1izgkpWqIow==
+    body:
+      encoding: UTF-8
+      string: ''
+    http_version: 
+  recorded_at: Thu, 26 May 2016 12:25:28 GMT
+recorded_with: VCR 2.9.3

data/spec/fixtures/vcr_cassettes/invalid_lock_id.yml

@@ -2,42 +2,39 @@
 http_interactions:
 - request:
     method: get
-    uri: https://api-2445581366752.apicast.io/api/v3/netcode/ncgenerator/getnetcode?user_key=<%= ENV['CODELOCKS_API_KEY'] || "wibble" %>&pid=<%= ENV['CODELOCKS_PAIRING_ID'] || "wobble" %>&id=Ninvalid&sd=20%2F10%2F2015&st=17&du=0
+    uri: "<BASE_URI>/netcode/invalid?id=invalid&start=2016-05-26+14%3A23&duration=0&lockmodel=K3CONNECT&identifier=<ACCESS_KEY>"
     body:
       encoding: US-ASCII
       string: ''
     headers:
       User-Agent:
       - Faraday v0.8.11
+      x-api-key:
+      - "<API_KEY>"
   response:
     status:
-      code: 200
+      code: 400
       message: 
     headers:
-      cache-control:
-      - no-store, no-cache, must-revalidate, post-check=0, pre-check=0
       content-type:
-      - text/html; charset=UTF-8
-      date:
-      - Tue, 20 Oct 2015 16:08:07 GMT
-      expires:
-      - Thu, 19 Nov 1981 08:52:00 GMT
-      pragma:
-      - no-cache
-      server:
-      - openresty/1.5.11.1
-      set-cookie:
-      - cpt=6f3e912e9b229f18247850a374fb632aba7dcdcb; expires=Tue, 20-Oct-2015 18:08:20
-        GMT; path=/; HttpOnly
-      x-powered-by:
-      - ASP.NET, 3scale API Management - http://www.3scale.net
+      - application/json
       content-length:
-      - '76'
+      - '69'
       connection:
-      - Close
+      - close
+      date:
+      - Thu, 26 May 2016 13:23:14 GMT
+      x-amzn-requestid:
+      - 0049c971-2345-11e6-b022-a34fe19ecf32
+      x-cache:
+      - Error from cloudfront
+      via:
+      - 1.1 77bdacfea247b6cbe84dffa90da5a554.cloudfront.net (CloudFront)
+      x-amz-cf-id:
+      - 18E863E-jYTMX-cnjhtKxk5tHW7KtAGh9SQutjmZSYhad-42blmbsw==
     body:
       encoding: UTF-8
-      string: '{"error":"Lock not found","message":"Please check the identifier provided."}'
+      string: '{"Message":"[\"[Invalid Data] ID (Expected: 12 or 32 characters)\"]"}'
     http_version: 
-  recorded_at: Tue, 20 Oct 2015 16:08:07 GMT
+  recorded_at: Thu, 26 May 2016 13:23:14 GMT
 recorded_with: VCR 2.9.3

data/spec/fixtures/vcr_cassettes/valid_access_key.yml

@@ -0,0 +1,42 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: "<BASE_URI>/lock?accesskey=<ACCESS_KEY>"
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v0.9.2
+      x-api-key:
+      - "<API_KEY>"
+  response:
+    status:
+      code: 200
+      message: 
+    headers:
+      content-type:
+      - application/json
+      content-length:
+      - '5248'
+      connection:
+      - close
+      date:
+      - Thu, 26 May 2016 12:25:27 GMT
+      access-control-allow-origin:
+      - "*"
+      x-amzn-requestid:
+      - ed3d5b8d-233c-11e6-abb5-dd54f7056380
+      x-cache:
+      - Miss from cloudfront
+      via:
+      - 1.1 421be81da20d58871d64dfde02cb2c46.cloudfront.net (CloudFront)
+      x-amz-cf-id:
+      - oppo1gBUyNzCnsGnsO8X4GZQZJxBinpZuOOjO34tKnj_hTbfvGWixQ==
+    body:
+      encoding: UTF-8
+      string: '[{"LockId":"<LOCK_ID>","LockName":"<LOCK_NAME>","BatteryStatus":"FULL","BatteryUpdated":"2016-05-24T00:00:00","Manufacturer":"CODELOCKS","ModelName":"<MODEL_NAME>","FirmwareVersion":"1.0.2","Timezone":"Europe/London","TimezoneOffset":"+0100","DstStart":"2016-03-27T00:00:00","DstEnd":"2016-10-30T00:00:00","DstTime":"01:00","PairingDate":"2016-05-24T00:00:00"},{"LockId":"<LOCK_ID>","LockName":"<LOCK_NAME>","BatteryStatus":"UNKNOWN","BatteryUpdated":"1970-01-01T00:00:00","Manufacturer":"CODELOCKS","ModelName":"<MODEL_NAME>","FirmwareVersion":"1.0.2","Timezone":"Europe/London","TimezoneOffset":"+0100","DstStart":"2016-03-27T00:00:00","DstEnd":"2016-10-30T00:00:00","DstTime":"01:00","PairingDate":"2016-05-05T00:00:00"},{"LockId":"<LOCK_ID>","LockName":"<LOCK_NAME>","BatteryStatus":"FULL","BatteryUpdated":"2016-05-23T00:00:00","Manufacturer":"CODELOCKS","ModelName":"<MODEL_NAME>","FirmwareVersion":"1.0.2","Timezone":"Europe/London","TimezoneOffset":"+0100","DstStart":"2016-03-27T00:00:00","DstEnd":"2016-10-30T00:00:00","DstTime":"01:00","PairingDate":"2016-05-23T00:00:00"}]'
+    http_version: 
+  recorded_at: Thu, 26 May 2016 12:25:27 GMT
+recorded_with: VCR 2.9.3

data/spec/fixtures/vcr_cassettes/valid_lock_id.yml

@@ -2,42 +2,39 @@
 http_interactions:
 - request:
     method: get
-    uri: https://api-2445581366752.apicast.io/api/v3/netcode/ncgenerator/getnetcode?user_key=<%= ENV['CODELOCKS_API_KEY'] || "wibble" %>&pid=<%= ENV['CODELOCKS_PAIRING_ID'] || "wobble" %>&id=N<%= ENV['CODELOCKS_LOCK_ID'] || "valid" %>&sd=20%2F10%2F2015&st=17&du=0
+    uri: "<BASE_URI>/netcode/LOCK_ID?id=LOCK_ID&start=2016-05-26+14%3A22&duration=0&lockmodel=K3CONNECT&identifier=<ACCESS_KEY>"
     body:
       encoding: US-ASCII
       string: ''
     headers:
       User-Agent:
       - Faraday v0.8.11
+      x-api-key:
+      - "<API_KEY>"
   response:
     status:
       code: 200
       message: 
     headers:
-      cache-control:
-      - no-store, no-cache, must-revalidate, post-check=0, pre-check=0
       content-type:
       - application/json
-      date:
-      - Tue, 20 Oct 2015 16:08:05 GMT
-      expires:
-      - Thu, 19 Nov 1981 08:52:00 GMT
-      pragma:
-      - no-cache
-      server:
-      - openresty/1.5.11.1
-      set-cookie:
-      - cpt=30457e50b3e443bcd1407f77f7b39d71df699388; expires=Tue, 20-Oct-2015 18:08:19
-        GMT; path=/; HttpOnly
-      x-powered-by:
-      - ASP.NET, 3scale API Management - http://www.3scale.net
       content-length:
-      - '53'
+      - '213'
       connection:
-      - Close
+      - close
+      date:
+      - Thu, 26 May 2016 13:22:19 GMT
+      x-amzn-requestid:
+      - dea40c96-2344-11e6-bba4-25d390521298
+      x-cache:
+      - Miss from cloudfront
+      via:
+      - 1.1 968f3ab48a1dd74b47de55452b46203d.cloudfront.net (CloudFront)
+      x-amz-cf-id:
+      - irPt9j9LX0JKOdnk809FtOnBaEdgV-oyvUxJRxbBmQuprkmDVkSTDA==
     body:
       encoding: UTF-8
-      string: '{"netcode":"000000","starttime":"2015\/10\/20\/17:0"}'
+      string: '{"Startdate":"2016-05-26T14:00:00","DurationHours":1,"DurationDays":0,"Mode":"standard","SubMode":"alltime","Timecode":null,"ActualNetcode":"178627","Resultstatus":null,"LockId":"LOCK_ID"}'
     http_version: 
-  recorded_at: Tue, 20 Oct 2015 16:08:05 GMT
+  recorded_at: Thu, 26 May 2016 13:22:19 GMT
 recorded_with: VCR 2.9.3

data/spec/spec_helper.rb

@@ -3,11 +3,13 @@ Dotenv.load
 
 require "codelocks"
 require "vcr"
+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("<PAIRING_ID>") { Codelocks.pairing_id }
-  config.filter_sensitive_data("<LOCK_ID>") { ENV['CODELOCKS_LOCK_ID'] }
+  config.filter_sensitive_data("<ACCESS_KEY>") { 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: 1.0.1
+  version: 2.0.0
 platform: ruby
 authors:
 - Robert May
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-21 00:00:00.000000000 Z
+date: 2016-05-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -80,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: faraday
   requirement: !ruby/object:Gem::Requirement
@@ -102,21 +116,26 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".ruby-version"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - codelocks.gemspec
 - lib/codelocks.rb
+- lib/codelocks/lock.rb
 - lib/codelocks/net_code.rb
-- lib/codelocks/net_code/request.rb
-- lib/codelocks/net_code/response.rb
+- lib/codelocks/request.rb
+- lib/codelocks/response.rb
 - lib/codelocks/version.rb
-- spec/codelocks/net_code/request_spec.rb
-- spec/codelocks/net_code/response_spec.rb
+- spec/codelocks/lock_spec.rb
 - spec/codelocks/net_code_spec.rb
+- spec/codelocks/request_spec.rb
+- spec/codelocks/response_spec.rb
 - spec/codelocks_spec.rb
+- spec/fixtures/vcr_cassettes/invalid_access_key.yml
 - spec/fixtures/vcr_cassettes/invalid_lock_id.yml
+- spec/fixtures/vcr_cassettes/valid_access_key.yml
 - spec/fixtures/vcr_cassettes/valid_lock_id.yml
 - spec/spec_helper.rb
 homepage: http://www.codelocks.co.uk
@@ -144,11 +163,14 @@ signing_key:
 specification_version: 4
 summary: A simple API wrapper for the CodeLocks API
 test_files:
-- spec/codelocks/net_code/request_spec.rb
-- spec/codelocks/net_code/response_spec.rb
+- spec/codelocks/lock_spec.rb
 - spec/codelocks/net_code_spec.rb
+- spec/codelocks/request_spec.rb
+- spec/codelocks/response_spec.rb
 - spec/codelocks_spec.rb
+- spec/fixtures/vcr_cassettes/invalid_access_key.yml
 - spec/fixtures/vcr_cassettes/invalid_lock_id.yml
+- spec/fixtures/vcr_cassettes/valid_access_key.yml
 - spec/fixtures/vcr_cassettes/valid_lock_id.yml
 - spec/spec_helper.rb
 has_rdoc: 

data/lib/codelocks/net_code/request.rb

@@ -1,34 +0,0 @@
-module Codelocks
-  module NetCode
-    class Request
-      class << self
-        # Perform a request against the NetCode API
-        #
-        # @param [String] path the URI path to perform the request against
-        # @param [Hash] params
-        # @option params [String] :sd The start date in format dd/mm/yyyy
-        # @option params [String] :st The start time, 0 spaced: 00-23
-        # @option params [Integer] :duration The duration for the code to be valid for
-        #
-        # @return [Codelocks::NetCode::Response]
-
-        def create(path, params = {})
-          response = Codelocks.connection.get(path, default_params.merge(params))
-          Response.new(response)
-        end
-
-        private
-        # The default params used in NetCode endpoint requests
-        #
-        # @return [Hash]
-
-        def default_params
-          {
-            user_key: Codelocks.api_key,
-            pid: Codelocks.pairing_id,
-          }
-        end
-      end
-    end
-  end
-end

data/lib/codelocks/net_code/response.rb

@@ -1,43 +0,0 @@
-require "json"
-
-module Codelocks
-  module NetCode
-    class Response
-      attr_reader :response
-
-      # Initialize the response object
-      #
-      # @param [Faraday::Response] faraday_response
-
-      def initialize(faraday_response)
-        @response = faraday_response
-      end
-
-      # Was the request successful?
-      #
-      # @return [Truthy]
-
-      def success?
-        response.success?
-      end
-
-      # Parse the response from the server if successful
-      #
-      # @return [Hash,Nil]
-
-      def body
-        if success?
-          @body ||= JSON.parse(response.body)
-        end
-      end
-
-      # Simple method missing accessor for reading returned attributes
-      #
-      # @return [String] the raw returned string from the API
-
-      def method_missing(method_name, *opts, &block)
-        body[method_name.to_s]
-      end
-    end
-  end
-end