crossbar-http 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 19a2298c3a79adeae874b6b4dcff452bbdf536a0
-  data.tar.gz: 2dc0cf90b84e592ae2b570665c17e6dcfa96c8ee
+  metadata.gz: 5bb9f8a404140d6b70bd23f5d8b89f09313b2a19
+  data.tar.gz: 6b78516ba76055fa4dd962ba85fa0a74247e3b49
 SHA512:
-  metadata.gz: ba1b8ddb833e5cf23c4f5dba920848d5795a54d6568d8ca92747339369f62ac146870dc9e5a2418a652f07b5febb65e06f51326c32e39c2ba71769a706fbc389
-  data.tar.gz: 8a0a5e9d2bae3b7958c8479600a2a12d91eb797b88eeed8acdc9788a7614fd9f505af947c33bbd2b0315735f564d9e4bece81ccd75cc46c04a9a18d43254b3a0
+  metadata.gz: ea38d47f7104caaf5008a680a9026c12cd46b4d355094badbf4a2a8790b345beb92516f856e2f069c9af2b249e88ba223670f90490b36b0541ef026eb5b8e9f6
+  data.tar.gz: b3b137f07ba6f11a94fb81fed455540e220195d0628b2233280ae77cfdbe4f12134621ce6e5a4d82186c67fbf7f4db6f30e84ecd47e260c6fdef291defe0ea2f

data/.gitignore

@@ -9,3 +9,4 @@
 /tmp/
 .idea/
 /dist/
+.DS_Store

data/README.md

@@ -1,16 +1,20 @@
 # Crossbar HTTP
 
 [![Gem Version](https://badge.fury.io/rb/crossbar-http.svg)](https://badge.fury.io/rb/crossbar-http)
+[![Circle CI](https://circleci.com/gh/ericchapman/ruby-crossbar-http/tree/master.svg?&style=shield&circle-token=d1d127456bc9210c10f34db5b6fd573fb228bed7)](https://circleci.com/gh/ericchapman/ruby-crossbar-http/tree/master)
+[![Codecov](https://img.shields.io/codecov/c/github/ericchapman/ruby-crossbar-http/master.svg)](https://codecov.io/github/ericchapman/ruby-crossbar-http)
 
 Module that provides methods for accessing Crossbar.io HTTP Bridge Services
 
 ## Revision History
 
-  - v0.1.0:
-    - Initial version
+  - v0.1.2:
+    - Added the ability to override the date serialization
   - v0.1.1:
     - Fixed typos in README
-    - Added support for https (I didn't know the library I was using didn't)
+    - Added support for https
+  - v0.1.0:
+    - Initial version
 
 ## Installation
 
@@ -60,18 +64,37 @@ def onJoin(self, details):
 ```
 
 ### Key/Secret
-For bridge services that have a key and secret defined, simply include the key and secret in the instantiation of the
-client.
+For bridge services that have a key and secret defined, simply include the key and secret 
+in the instantiation of the client.
 
 ``` ruby
 client = Crossbar::HTTP::Client.new("http://127.0.0.1/publish", key: "key", secret: "secret")
 ```
 
+### Pre-Serialize Callback
+The library provides a "pre-serialize" callback which will allow the user to
+modify certain object types before the payload is serialized.  This can be used
+for things like changing the date/time to a custom value.  See an example of
+doing this below
+
+``` ruby
+pre_serialize = lambda { |value|
+  if value.is_a? Date
+    return value.strftime("%Y/%m/%d %H:%M:%S.%L %Z")
+  end
+}
+client = Crossbar::HTTP::Client.new("http://127.0.0.1/publish", pre_serialize: pre_serialize)
+```
+
 ## Contributing
 To contribute, fork the repo and submit a pull request.
 
 ## Testing
-TODO
+To run the unit tests, execute the following
+
+```
+%> rake spec
+```
 
-##License
+## License
 MIT

data/crossbar-http.gemspec

@@ -24,4 +24,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler', '~> 1.13'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'simplecov', '~> 0.12.0'
+  spec.add_development_dependency 'codecov'
 end

data/lib/crossbar-http/client.rb

@@ -33,14 +33,15 @@ require 'json'
 module Crossbar
   module HTTP
     class Client
-      attr_accessor :url, :key, :secret, :verbose, :sequence
+      attr_accessor :url, :key, :secret, :verbose, :sequence, :pre_serialize
 
       # Initializes the client
       # @param url [String] - The url of the router's HTTP bridge
       # @param key [String] - The key (optional)
       # @param secret [String] - The secret (optional)
       # @param verbose [Bool] - 'True' if you want debug messages printed
-      def initialize(url, key: nil, secret: nil, verbose: false)
+      # @param pre_serialize [lambda] - Lambda to format the data
+      def initialize(url, key: nil, secret: nil, verbose: false, pre_serialize: nil)
 
         raise 'The url can not be nil' unless url != nil
 
@@ -48,6 +49,7 @@ module Crossbar
         self.key = key
         self.secret = secret
         self.verbose = verbose
+        self.pre_serialize = pre_serialize
         self.sequence = 1
       end
 
@@ -83,15 +85,34 @@ module Crossbar
         self._make_api_call(params)
       end
 
+      # Parses the params to pre-serialize the overrides
+      def _parse_params(params)
+
+        if params.is_a? Hash
+          return_value = {}
+          params.each do |key, value|
+            return_value[key] = self._parse_params(value)
+          end
+        elsif params.is_a? Array
+          return_value = []
+          params.each_index {|i|
+            return_value.push(self._parse_params (params[i]))
+          }
+        else
+          return_value = self.pre_serialize.call(params) || params
+        end
+
+        return_value
+      end
+
       # Computes the signature.
       # Described at: http://crossbar.io/docs/HTTP-Bridge-Services-Caller/
       # Reference code is at: https://github.com/crossbario/crossbar/blob/master/crossbar/adapter/rest/common.py
       # @param body [Hash]
       # @return (signature, nonce, timestamp)
-      def _compute_signature(body, nonce: nil, timestamp: nil)
-
-        timestamp ||= Time.now.utc.strftime('%Y-%m-%dT%H:%M:%S.%LZ')
-        nonce ||= rand(0..2**53)
+      def _compute_signature(body)
+        timestamp = self.class._get_timestamp
+        nonce = self.class._get_nonce
 
         # Compute signature: HMAC[SHA256]_{secret} (key | timestamp | seq | nonce | body) => signature
         hm = OpenSSL::HMAC.new(self.secret, OpenSSL::Digest::SHA256.new)
@@ -105,11 +126,28 @@ module Crossbar
         return signature, nonce, timestamp
       end
 
+      def self._get_timestamp
+        Time.now.utc.strftime('%Y-%m-%dT%H:%M:%S.%LZ')
+      end
+
+      def self._get_nonce
+        rand(0..2**53)
+      end
+
+      # Performs the API call
+      # @param json_params [Hash,nil] The parameters that will make up the body of the request
+      # @return [Hash] The response from the server
       def _make_api_call(json_params=nil)
 
         puts "Crossbar::HTTP - Request: POST #{url}" if self.verbose
 
-        encoded_params = (json_params != nil) ? JSON.generate(json_params) : nil
+        encoded_params = nil
+        if json_params != nil
+          if self.pre_serialize&.is_a? Proc
+            json_params = self._parse_params json_params
+          end
+          encoded_params = JSON.generate(json_params)
+        end
 
         puts "Crossbar::HTTP - Params: #{encoded_params}" if encoded_params != nil and self.verbose
 
@@ -132,11 +170,20 @@ module Crossbar
         # TODO: Not sure what this is supposed to be but this works
         self.sequence += 1
 
+        self._api_call uri, encoded_params
+      end
+
+      # This method makes tha API call.  It is a class method so it can be more easily stubbed
+      # for testing
+      # @param uri [URI] The uri of the request
+      # @param body [String] The body of the request
+      # @return [Hash] The response from the server
+      def _api_call(uri, body=nil)
         # Create the request
         res = Net::HTTP.start(uri.hostname, uri.port, :use_ssl => uri.scheme == 'https') do |http|
           req = Net::HTTP::Post.new(uri)
           req['Content-Type'] = 'application/json'
-          req.body = encoded_params
+          req.body = body
 
           http.request(req)
         end
@@ -148,7 +195,6 @@ module Crossbar
           else
             raise "Crossbar::HTTP - Code: #{res.code}, Error: #{res.message}"
         end
-
       end
     end
   end

data/lib/crossbar-http/version.rb

@@ -1,5 +1,5 @@
 module Crossbar
   module HTTP
-    VERSION = '0.1.1'
+    VERSION = '0.1.2'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: crossbar-http
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Eric Chapman
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-02-12 00:00:00.000000000 Z
+date: 2017-07-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+- !ruby/object:Gem::Dependency
+  name: codecov
+  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'
 description: ''
 email:
 - eric.chappy@gmail.com