lockme 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1ef8f125b89e9768fc655846a789cebeb6b528c1
-  data.tar.gz: 6c9886a66d6cf22dcc53de92767893d5a09f349b
+  metadata.gz: 524261899efd42507740502d05f185f9acf04c0a
+  data.tar.gz: f92acf0789df28f6970379739e44dfff01b1a654
 SHA512:
-  metadata.gz: 7742c5b0218e8e2c0fbaf93e4f7f2ff7bee1f397a9cff591b8f4fe1eac15ca396148033bfea200cdeddd175aa5d87ab388537377c28e2501c7f1338b4b353844
-  data.tar.gz: 9bbd62b782b4c7ea7af643079e5d3e7e0a9a147144880f6a4de072b76d41383fdbc7dbd4f3a36849bd15ed1b04124c8cde6b5f6ed92cd9a7059abf8b9f9f9649
+  metadata.gz: db3f67c37fc6332d6b1131983f4b0824bbc1b12ca40f032b6a6d28f355d806d8496fb58857ecbc2ec01db673a7f1e0e1d404092c404614c7bf76443c8d142d96
+  data.tar.gz: 581add854ee6105efa0810dd5ca7771d1faca895efbc905fb46350d81464ac05efeba22adb4badf720d82d7331c47fd8a1e19a4d082885348ec40daa87495367

data/.rubocop.yml

@@ -0,0 +1,25 @@
+AllCops:
+  Exclude:
+    - examples/*
+    - '*'
+    - bin/*
+
+Style/StringLiterals:
+  Enabled: false
+Style/StringLiteralsInInterpolation:
+  Enabled: false
+Style/PreferredHashMethods:
+  EnforcedStyle: verbose
+Style/NumericLiterals:
+  Exclude:
+    - test/*_test.rb
+Metrics/BlockLength:
+  Exclude:
+    - test/*_test.rb
+Style/FrozenStringLiteralComment:
+  Exclude:
+    - test/*_test.rb
+Metrics/LineLength:
+  Exclude:
+    - test/*_test.rb
+

data/examples/README.md

@@ -0,0 +1,5 @@
+# Lockme examples
+
+## Basic usage
+
+CRUD operations on LockMe API.

data/examples/basic.rb

@@ -0,0 +1,27 @@
+# Find a reservation using an ID from LockMe. Returns an instance of Lockme::Reservation
+Lockme::Reservation.find(lockme_id)
+
+# Provide a hash of attributes expected by LockMe API
+def to_lockme_hash
+  {
+    reservationid: lockme_id,
+    roomid: room_id,
+    date: start_at.strftime("%Y-%m-%d"),
+    hour: start_at.strftime("%H:%M:%S"),
+    people: 4,
+    pricer: '1',
+    price: '%.2f' % BigDecimal.new(price),
+    name: first_name,
+    surname: last_name,
+    email: email,
+    phone: phone,
+    comment: nil,
+    extid: id.to_s
+  }.compact
+end
+
+# Save or update a reservation. Returns an instance of Lockme::Reservation
+Lockme::Reservation.new(to_lockme_hash).save
+
+# Destroy a reservation. Returns `true` on success
+Lockme::Reservation.new(reservationid: lockme_id).destroy

data/lib/lockme/base.rb

@@ -1,5 +1,31 @@
+# frozen_string_literal: true
+
 module Lockme
+  # Base class for all LockMe API objects
   class Base
     include JsonUtils
+
+    class << self; attr_reader :base_path end
+
+    # Check if object is persisted with Lockme
+    def persisted?
+      !id.nil?
+    end
+
+    def singular_path
+      self.class.singular_path(id)
+    end
+
+    def collection_path
+      self.class.collection_path
+    end
+
+    def self.singular_path(id)
+      [base_path, id].join('/')
+    end
+
+    def self.collection_path
+      base_path
+    end
   end
 end

data/lib/lockme/configuration.rb

@@ -1,4 +1,8 @@
+# frozen_string_literal: true
+
+#:nodoc:
 module Lockme
+  # Mixin providing gem configuration options methods
   module Configuration
     def api_key
       defined?(@api_key) ? @api_key : nil

data/lib/lockme/error.rb

@@ -1,4 +1,7 @@
+# frozen_string_literal: true
+
 module Lockme
+  # Error class
   class Error < StandardError
   end
 end

data/lib/lockme/json_utils.rb

@@ -1,7 +1,18 @@
+# frozen_string_literal: true
+
+#:nodoc:
 module Lockme
+  # Mixin providing JSON encoding method compatible with LockMe API
   module JsonUtils
     def to_json
-      @data.to_h.to_json.force_encoding('UTF-8').each_codepoint.reduce('') {|str, c| str << (c > 127 ? '\u'+c.to_s(16).rjust(4, '0') : c.chr) }
+      utf_str = @data.to_h.to_json.force_encoding('UTF-8')
+      utf_str.each_codepoint.reduce(+'') do |str, codepoint|
+        str << if codepoint > 127
+                 '\u' + codepoint.to_s(16).rjust(4, '0')
+               else
+                 codepoint.chr
+               end
+      end
     end
   end
   private_constant :JsonUtils

data/lib/lockme/request.rb

@@ -1,35 +1,43 @@
+# frozen_string_literal: true
+
 module Lockme
+  # API request module providing argument processing and signing
   module SignedRequest
     def self.perform(method, path, data = nil)
-      headers = signature(method.upcase, path.gsub(/^\//, ''), data)
-      params = {
-        body: data,
-        headers: headers,
-        debug_output: Lockme.logger
-      }.delete_if {|k,v| k.nil? || v.nil? }
+      params = prepare_params(method, path, data)
 
       resp = Request.send(method.downcase, path, params).parsed_response
-      if resp.is_a?(Hash) && resp['error']
-        raise Lockme::Error.new(resp['error'])
+      if resp.is_a?(Hash) && resp.has_key?('error')
+        raise Lockme::Error, resp['error']
       end
       resp
     rescue JSON::ParserError
-      raise Lockme::Error.new('Invalid response from the server')
+      raise Lockme::Error, 'Invalid response from the server'
     end
 
     def self.signature(*args)
-      sha1 = Digest::SHA1.hexdigest([
+      digest = Digest::SHA1.hexdigest([
         *args,
         Lockme.api_secret
       ].compact.join(''))
 
       {
         'Partner-Key' => Lockme.api_key,
-        'Signature'   => sha1
+        'Signature'   => digest
       }
     end
+
+    def self.prepare_params(method, path, data)
+      headers = signature(method.upcase, path.gsub(%r{^\/}, ''), data)
+      {
+        body: data,
+        headers: headers,
+        debug_output: Lockme.logger
+      }.delete_if { |key, val| key.nil? || val.nil? }
+    end
   end
 
+  # HTTParty wrapper including some basic configuration
   module Request
     include ::HTTParty
 
@@ -37,7 +45,7 @@ module Lockme
       'User-Agent'    => 'Ruby.Lockme.Api',
       'Accept'        => 'application/json',
       'Content-Type'  => 'application/json'
-    }
+    }.freeze
     API_VERSION = '1.1'
 
     base_uri "https://lockme.pl/api/v#{API_VERSION}/"

data/lib/lockme/reservation.rb

@@ -1,11 +1,20 @@
+# frozen_string_literal: true
+
 module Lockme
+  # LockMe API reservation object
   class Reservation < Lockme::Base
+    @base_path = '/reservation'
+
     def initialize(args = {})
       parse_lockme_json(args)
     end
 
+    def id
+      reservationid
+    end
+
     def self.find(lockme_id)
-      self.new(Lockme::SignedRequest.perform("get", "/reservation/#{lockme_id}"))
+      new(SignedRequest.perform("get", singular_path(lockme_id)))
     end
 
     def save
@@ -17,29 +26,25 @@ module Lockme
     end
 
     def destroy
-      Lockme::SignedRequest.perform("delete", "/reservation/#{@data.reservationid}")
-    end
-
-    # Check if object is persisted with Lockme
-    def persisted?
-      !@data.reservationid.nil?
+      SignedRequest.perform("delete", singular_path)
     end
 
     # Provide attribute accessors
-    def method_missing(method, *args)  
+    def method_missing(method, *args)
       @data.send method, *args
     end
 
     def create
-      @data.reservationid = Lockme::SignedRequest.perform("put", "/reservation", self.to_json)
-      return self
+      resp = SignedRequest.perform("put", collection_path, to_json)
+      @data.reservationid = resp
+      self
     end
     private :create
 
     def update
-      resp = Lockme::SignedRequest.perform("post", "/reservation/#{@data.reservationid}", self.to_json)
+      resp = SignedRequest.perform("post", singular_path, to_json)
       parse_lockme_json(resp)
-      return self
+      self
     end
     private :update
 

data/lib/lockme/room.rb

@@ -1,4 +1,7 @@
+# frozen_string_literal: true
+
 module Lockme
+  # LockMe API room collection
   class Room < Lockme::Base
     def self.all
       Lockme::SignedRequest.perform("get", "/rooms")

data/lib/lockme/test.rb

@@ -1,4 +1,8 @@
+# frozen_string_literal: true
+
+#:nodoc:
 module Lockme
+  # Mixin providing a method to test API connection
   module Test
     def test
       Lockme::SignedRequest.perform('get', '/test')

data/lib/lockme/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Lockme
-  VERSION = "0.4.0"
+  VERSION = "0.4.1"
 end

data/lib/lockme.rb

@@ -1,5 +1,7 @@
-require 'httparty'
+# frozen_string_literal: true
+
 require 'forwardable'
+require 'httparty'
 
 require 'lockme/configuration'
 require 'lockme/json_utils'
@@ -11,6 +13,7 @@ require 'lockme/reservation'
 require 'lockme/room'
 require 'lockme/version'
 
+#:nodoc:
 module Lockme
   extend Configuration
   extend Test

data/lockme.gemspec

@@ -21,8 +21,8 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler", "~> 1.14"
-  spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "simplecov"
   spec.add_dependency "httparty", "~> 0.15.6"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lockme
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Mike Szyndel
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-01-05 00:00:00.000000000 Z
+date: 2018-01-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -25,33 +25,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.14'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '5.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '10.0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -88,6 +88,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rubocop.yml"
 - ".travis.yml"
 - Gemfile
 - LICENSE.txt
@@ -95,6 +96,8 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- examples/README.md
+- examples/basic.rb
 - lib/lockme.rb
 - lib/lockme/base.rb
 - lib/lockme/configuration.rb