ribbon-intercom 0.3.4 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6735bd14a8d50fd75364a3b6c31aaffbd08e733d
-  data.tar.gz: 370a4652cbdcc027683b64278a57ca580b2aab88
+  metadata.gz: dbc66058ef3f67f202ae929f759b20a1ca45a0f7
+  data.tar.gz: d5eee408147e0cf447120c6f2ee8150cba30cec9
 SHA512:
-  metadata.gz: e4e1891d25f6cb156a798abb60fb37e7839faaebcd361ad0e507e490caacc78d294248d7347719f31039c514baa5fd14032526d9c501228a6be6ae1a4ae304f0
-  data.tar.gz: 7e09d2709f559018785c38d9724ac7797c7f28ec0b58d022ff2585baaf1e55ae48cb555467c9a413bd2c9458a4f05538db1159c102bc269279947da1f206b591
+  metadata.gz: ed1f4b07d38b1fca0657cc08ec4fac171ae9fc65a7132f9afe4f46a9043d6104d4fec26ade902ab93bed155102365fdf56518dfbf93b0a2695805173b8d834b3
+  data.tar.gz: 723e68476ea49afd0cf055e2ce6adcfb8636ea6c7d12625abfa9ff2486a1502bc4507af01a7fbfc5f4d8935ee1b0bc82de2a9e223547e99ec9513a6cd9e8fe81

data/lib/ribbon/intercom.rb

@@ -9,6 +9,7 @@ module Ribbon
     autoload(:Client,      'ribbon/intercom/client')
     autoload(:Package,     'ribbon/intercom/package')
     autoload(:Packageable, 'ribbon/intercom/packageable')
+    autoload(:Packet,      'ribbon/intercom/packet')
     autoload(:Utils,       'ribbon/intercom/utils')
 
     module_function

data/lib/ribbon/intercom/client/sdk.rb

@@ -18,6 +18,14 @@ module Ribbon::Intercom
         end
       end
 
+      def begin
+        Utils::MethodChain.begin { |methods|
+          queue = Packet::MethodQueue.new
+          methods.each { |meth, *args| queue.enqueue(meth, *args) }
+          send_packet(method_queue: queue).retval
+        }
+      end
+
       ##
       # Returns the headers defined for this SDK. Optionally, you may also define
       # additional headers you'd like to add/override.
@@ -34,11 +42,19 @@ module Ribbon::Intercom
       end
 
       ##
-      # Calls the method on the adapter returning the Adapter::Response.
+      # Calls the method on the adapter returning the response Packet
+      def call(method_name, *args)
+        send_packet(
+          method_queue: Packet::MethodQueue.new.enqueue(method_name, *args)
+        )
+      end
+
+      ##
+      # Sends the packet with the adapter, returning the response Packet.
       #
       # Intended to be called by Package.
-      def call(method_name, *args)
-        _process_response(adapter.call(method_name, *args))
+      def send_packet(packet)
+        _process_response(adapter.send_packet(packet))
       end
 
       def dup
@@ -64,32 +80,20 @@ module Ribbon::Intercom
       end
 
       ##
-      # Process an Adapter::Response object returned by Adapter#call.
-      def _process_response(response)
-        _handle_response_error(response) unless response.successful?
+      # Process a Packet object returned by Adapter#send_packet.
+      def _process_response(packet)
+        _handle_response_error(packet) if packet.error?
 
-        _init_packages(response.retval)
-        response
+        _init_packages(packet.retval)
+        packet
       end
 
       ##
       # Raises an error depending on what went wrong.
-      def _handle_response_error(response)
-        raise 'called for successful response' if response.successful?
-
-        encoded_error = response.headers['X-Intercom-Error']
-
-        if encoded_error && !encoded_error.empty?
-          begin
-            decoded_error = Base64.strict_decode64(encoded_error)
-            error = Marshal.load(decoded_error)
-          rescue
-            error = Errors::ServerError.new('unknown server error')
-          end
-        end
-
-        raise error || Errors::ServerError.new('unexpected server error')
-      end # _handle_response
+      def _handle_response_error(packet)
+        raise 'packet contains no error' unless packet.error?
+        raise packet.error
+      end
 
       ##
       # Walks the object and initializes all packages (i.e., sets them up to be

data/lib/ribbon/intercom/client/sdk/adapters/adapter.rb

@@ -9,11 +9,22 @@ module Ribbon::Intercom
 
       ##
       # Call the method on the service.
+      #
+      # @deprecated This method is only called by tests. Don't call it elsewhere.
       def call(method_name, *args)
-        call!(method_name, _encode_args(*args)).tap { |response|
-          raise TypeError, "call! should return an Adapter::Response" unless response.is_a?(Response)
-          raise "response should have correct method name" unless response.method_name == method_name.to_sym
-        }
+        send_packet(
+          method_queue: Packet::MethodQueue.new.enqueue(method_name, *args)
+        )
+      end
+
+      ##
+      # Send a packet to the service and returns the Packet returned by the service.
+      def send_packet(packet)
+        packet = Packet.new(packet) if packet.is_a?(Hash)
+
+        send_packet!(packet.encode).tap { |response|
+          raise TypeError, "send_packet! should return an Adapter::Response" unless response.is_a?(Response)
+        }.packet
       end
 
       ##
@@ -43,8 +54,8 @@ module Ribbon::Intercom
       end
 
       ##
-      # Actually call the method on the service. Should return an Adapter::Response object.
-      def call!(method_name, *args)
+      # Actually send the packet to the service. Should return an Adapter::Response object.
+      def send_packet!(packet)
         raise NotImplementedError
       end
 

data/lib/ribbon/intercom/client/sdk/adapters/adapter/response.rb

@@ -1,37 +1,12 @@
 module Ribbon::Intercom
   class Client::SDK::Adapters::Adapter
     class Response < Rack::Response
-      attr_reader :method_name
-
-      def initialize(body, status, headers, method_name)
-        super(body, status, headers)
-        @method_name = method_name.to_sym
-      end
-
-      def missing_permissions
-        @__missing_permissions ||= _intercom_permissions_missing
-      end
-
       def body
         super.join
       end
 
-      ##
-      # Decode the response body received from the service.
-      def retval
-        @__retval ||= Marshal.load(Base64.strict_decode64(body)) unless body.empty?
-      end
-
-      private
-
-      def _intercom_permissions_missing
-        key = _intercom_permissions_missing_header
-        headers[key] && headers[key].split(',').to_set
-      end
-
-      def _intercom_permissions_missing_header
-        missing_keys = ['X-Intercom-Permissions-Missing', :x_intercom_permissions_missing]
-        missing_keys.detect { |key| headers.key?(key) }
+      def packet
+        @__packet ||= Packet.decode(body) unless body.empty?
       end
     end # Response
   end # Client::SDK::Adapters::Adapter

data/lib/ribbon/intercom/client/sdk/adapters/http_adapter.rb

@@ -17,13 +17,15 @@ module Ribbon::Intercom
         @__connection ||= Connection.new(*@_connection_args)
       end
 
-      def call!(method_name, encoded_args)
+      ##
+      # Send the encoded packet up to the service via an HTTP PUT.
+      def send_packet!(encoded_packet)
         response = connection.put(
-          headers: headers.merge("X-Intercom-Method" => method_name),
-          body:    encoded_args
+          headers: headers,
+          body:    encoded_packet
         )
 
-        Adapter::Response.new(response.body, response.code.to_i, response, method_name)
+        Adapter::Response.new(response.body, response.code.to_i, response)
       end
     end # HttpAdapter
   end # Client::SDK::Adapters

data/lib/ribbon/intercom/client/sdk/adapters/local_adapter.rb

@@ -23,17 +23,18 @@ module Ribbon::Intercom
         !!service
       end
 
-      def call!(method_name, encoded_args)
+      ##
+      # Mimics an HTTP PUT
+      def send_packet!(encoded_packet)
         response = service.call(
           _http_headers.merge(
             'HTTP_AUTHORIZATION'     => _http_auth,
-            'HTTP_X_INTERCOM_METHOD' => method_name.to_s,
             'REQUEST_METHOD'         => 'PUT',
-            'rack.input'             => StringIO.new(encoded_args)
+            'rack.input'             => StringIO.new(encoded_packet)
           )
         )
 
-        Response.new(response[2], response[0], response[1], method_name)
+        Adapter::Response.new(response[2], response[0], response[1])
       end
 
       private

data/lib/ribbon/intercom/errors.rb

@@ -2,6 +2,11 @@ module Ribbon::Intercom
   module Errors
     class Error < StandardError; end
 
+    ##
+    # Packet errors
+    class PacketError < Error; end
+    class InvalidEncodingError < PacketError; end
+
     #############
     # Http Errors
     class HttpError < Error; end

data/lib/ribbon/intercom/package.rb

@@ -7,20 +7,20 @@ module Ribbon::Intercom
     attr_reader :sdk
 
     def initialize(subject_data=nil, data=nil)
-      self._subject_data = subject_data
+      @_subject_data = subject_data
       @_data = data
     end
 
     def sdk=(sdk)
-      _set_sdk_headers(sdk)
       @sdk = sdk
     end
 
-    protected
-
-    def _subject_data=(data)
-      @_subject_data = data
-      _set_sdk_headers
+    def begin
+      Utils::MethodChain.begin { |methods|
+        queue = Packet::MethodQueue.new
+        methods.each { |meth, *args| queue.enqueue(meth, *args) }
+        _send_method_queue(queue)
+      }
     end
 
     private
@@ -29,35 +29,35 @@ module Ribbon::Intercom
       if @_data && @_data.key?(meth)
         @_data[meth]
       elsif sdk
-        _process_response(sdk.call(meth, *args))
+        _send_method_queue(Packet::MethodQueue.new.enqueue(meth, *args))
       else
         super
       end
     end
 
+    def _send_method_queue(method_queue)
+      _process_response(
+        sdk.send_packet(
+          subject:      @_subject_data,
+          method_queue: method_queue
+        )
+      )
+    end
+
     def marshal_dump
       [@_subject_data, @_data]
     end
 
     def marshal_load(array)
-      self._subject_data = array[0]
+      @_subject_data = array[0]
       @_data = array[1]
     end
 
-    def _set_sdk_headers(sdk=sdk)
-      sdk.headers('X-Intercom-Subject' => @_subject_data) if sdk
-    end
-
-    def _process_response(response)
-      self._subject_data = response.headers['X-Intercom-Subject']
-      @_data = _retrieve_data_from_response(response)
-
-      response.retval
-    end
+    def _process_response(packet)
+      @_subject_data = packet.subject
+      @_data = packet.package_data
 
-    def _retrieve_data_from_response(response)
-      encoded_data = response.headers['X-Intercom-Package-Data']
-      encoded_data && Marshal.load(Base64.strict_decode64(encoded_data))
+      packet.retval
     end
   end # Package
 end # Ribbon::Intercom

data/lib/ribbon/intercom/packageable/mixin.rb

@@ -26,10 +26,6 @@ module Ribbon::Intercom
           self.class._package_with_methods.map { |meth| [meth, public_send(meth)] }.to_h
         )
       end
-
-      def encoded_package_data
-        Base64.strict_encode64(Marshal.dump(package_data))
-      end
     end # Mixin
   end # Service::Subject
 end # Ribbon::Intercom

data/lib/ribbon/intercom/packet.rb

@@ -0,0 +1,52 @@
+require 'ostruct'
+require 'base64'
+
+module Ribbon::Intercom
+  ##
+  # Represents a collection of data to be passed between the service and client.
+  class Packet < OpenStruct
+    autoload(:MethodQueue, 'ribbon/intercom/packet/method_queue')
+
+    class << self
+      def decode(encoded_packet)
+        hash = Marshal.load(Base64.strict_decode64(encoded_packet))
+        raise Errors::InvalidEncodingError, hash.inspect unless hash.is_a?(Hash)
+        new(hash)
+      end
+    end # Class Methods
+
+    def initialize(params={})
+      error = params.delete(:error)
+      super(params)
+      self.error = error if error
+    end
+
+    ##
+    # Encode (marshal) the error before saving it. This allows the error to be
+    # decoded on the client when requested, rather than decoded at the same time
+    # the packet is decoded, which could cause problems if the error class doesn't
+    # exist on the client.
+    def error=(err)
+      self._encoded_error = Marshal.dump(err)
+    end
+
+    ##
+    # Decode the error, which may not exist on the client.
+    # If the error class doesn't exist on the client, raise a ServerError.
+    def error
+      error? && Marshal.load(_encoded_error)
+    rescue
+      Errors::ServerError.new('unknown server error')
+    end
+
+    ##
+    # Whether the packet contains an error
+    def error?
+      !!_encoded_error
+    end
+
+    def encode
+      Base64.strict_encode64(Marshal.dump(to_h))
+    end
+  end # Packet
+end # Ribbon::Intercom

data/lib/ribbon/intercom/packet/method_queue.rb

@@ -0,0 +1,28 @@
+module Ribbon::Intercom
+  class Packet
+    class MethodQueue
+      ##
+      # Enqueue a method with it's arguments.
+      # Supports method chaining.
+      def enqueue(name, *args)
+        self.tap { _queue << [name, *Utils.sanitize(args)] }
+      end
+
+      ##
+      # Iterate through the methods and arguments.
+      def each(&block)
+        _queue.each(&block)
+      end
+
+      def empty?
+        _queue.empty?
+      end
+
+      private
+
+      def _queue
+        @__queue ||= []
+      end
+    end # MethodQueue
+  end # Packet
+end # Ribbon::Intercom

data/lib/ribbon/intercom/service.rb

@@ -44,6 +44,7 @@ module Ribbon::Intercom
     attr_reader :request
     attr_reader :channel
     attr_reader :subject
+    attr_reader :request_packet
     attr_reader :env
 
     def initialize(opts={})
@@ -65,8 +66,8 @@ module Ribbon::Intercom
       store.lookup_channel(token)
     end
 
-    def sufficient_permissions?(intercom_method)
-      channel.may?(Utils.method_identifier(subject, intercom_method))
+    def sufficient_permissions?(base, intercom_method)
+      Utils.basic_type?(base) || channel.may?(Utils.method_identifier(base, intercom_method))
     end
 
     def call(env)
@@ -78,8 +79,7 @@ module Ribbon::Intercom
 
       response = catch(:response) {
         begin
-          intercom_method, args = _process_request
-          _call_method(intercom_method, *args)
+          _process_request
         rescue Exception => error
           _respond_with_error!(error)
         end
@@ -97,8 +97,10 @@ module Ribbon::Intercom
     def _process_request
       _init_request
       _authenticate_request!
+      _load_request_packet
       _load_subject
-      [_load_method, _load_args]
+      response_packet = _process_methods
+      _respond_with_packet(response_packet)
     end
 
     def _init_request
@@ -115,8 +117,12 @@ module Ribbon::Intercom
       end
     end
 
+    def _load_request_packet
+      @request_packet = Packet.decode(request.body.read)
+    end
+
     def _load_subject
-      if (encoded_subject=env['HTTP_X_INTERCOM_SUBJECT']) && !encoded_subject.empty?
+      if (encoded_subject=request_packet.subject) && !encoded_subject.empty?
         @subject = _decode_subject(encoded_subject)
         _error!(Errors::InvalidSubjectSignatureError) unless @subject
       else
@@ -124,35 +130,27 @@ module Ribbon::Intercom
       end
     end
 
-    def _load_method
-      env['HTTP_X_INTERCOM_METHOD'].to_sym.tap { |intercom_method|
-        _sufficient_permissions!(intercom_method)
-      }
-    end
-
-    def _load_args
-      _decode_args(request.body.read)
-    rescue Errors::UnsafeValueError
-      _error!(Errors::UnsafeArgumentError, "One or more argument type is invalid.")
+    ##
+    # Calls requested methods and returns a response packet for the client.
+    def _process_methods
+      retval = _call_methods
+      _prepare_response_packet(retval)
     end
 
     ##
-    # Call the method on the subject with the args.
-    def _call_method(intercom_method, *args)
-      body = _package(subject.public_send(intercom_method, *args))
-
-      headers = {}
-      unless self == subject # Order matters here! See: issue#52
-        # Need to send subject back in case it was modified by the method.
-        headers['X-Intercom-Subject'] = _encode_subject(subject)
-
-        if subject.is_a?(Packageable::Mixin)
-          # Need to send the package data back in case it changed, too.
-          headers['X-Intercom-Package-Data'] = subject.encoded_package_data
-        end
-      end
+    # Call all the methods in the method queue.
+    def _call_methods
+      method_queue = _load_method_queue
+
+      intercom_method = nil
+      base = subject
+      method_queue.each { |meth, *args|
+        intercom_method = meth
+        _sufficient_permissions!(base, meth)
+        base = base.public_send(meth, *args)
+      }
 
-      _respond!(200, headers, body)
+      _package(base)
     rescue NoMethodError => error
       if error.name == intercom_method
         _error!(Errors::InvalidMethodError, intercom_method)
@@ -161,6 +159,36 @@ module Ribbon::Intercom
       end
     end
 
+    def _load_method_queue
+      request_packet.method_queue.tap { |mq|
+        raise "No method queue given" unless mq
+        raise "Expected MethodQueue, got: #{mq.inspect}" unless mq.is_a?(Packet::MethodQueue)
+        raise "Empty MethodQueue" if mq.empty?
+      }
+    end
+
+    ##
+    # Creates a successful response Packet to be returned to the client.
+    def _prepare_response_packet(retval)
+      Packet.new.tap { |packet|
+        unless self == subject # Order matters here! See: issue#52
+          # Need to send subject back in case it was modified by the methods.
+          packet.subject = _encode_subject(subject)
+
+          if subject.is_a?(Packageable::Mixin)
+            # Need to send the package data back in case it changed, too.
+            packet.package_data = subject.package_data
+          end
+        end
+
+        packet.retval = retval
+      }
+    end
+
+    def _respond_with_packet(packet, status=200)
+      _respond!(status, {}, packet.encode)
+    end
+
     ##
     # Package up any non-basic objects that include Packageable::Mixin.
     def _package(object)
@@ -187,14 +215,13 @@ module Ribbon::Intercom
     ##
     # Marshal dumps the subject and signs the resulting bytes with the channel.
     def _encode_subject(subject)
-      Base64.strict_encode64(channel.sign(Marshal.dump(subject)))
+      channel.sign(Marshal.dump(subject))
     end
 
     ##
     # Decodes the subject sent from the client.
     def _decode_subject(encoded_subject)
-      signed_subject = Base64.strict_decode64(encoded_subject)
-      marshalled_subject = channel.verify(signed_subject)
+      marshalled_subject = channel.verify(encoded_subject)
       marshalled_subject && Marshal.load(marshalled_subject)
     end
 
@@ -211,15 +238,15 @@ module Ribbon::Intercom
       end
     end
 
-    def _sufficient_permissions!(intercom_method)
-      unless sufficient_permissions?(intercom_method)
-        required = Utils.method_identifier(subject, intercom_method)
+    def _sufficient_permissions!(base, intercom_method)
+      unless sufficient_permissions?(base, intercom_method)
+        required = Utils.method_identifier(base, intercom_method)
         _error!(Errors::InsufficientPermissionsError, required)
       end
     end
 
     def _response(status, headers={}, body=EmptyResponse)
-      body = body == EmptyResponse ? [] : [_encode_body(body)]
+      body = body == EmptyResponse ? [] : [body]
       headers = headers.merge("Content-Type" => "text/plain", "Transfer-Encoding" => "gzip")
       Rack::Response.new(body, status, headers)
     end
@@ -229,7 +256,7 @@ module Ribbon::Intercom
     end
 
     def _respond_with_error!(error, status=500)
-      _respond!(status, { 'X-Intercom-Error' => _encode_error(error) })
+      _respond_with_packet(Packet.new(error: error), status)
     end
 
     def _error!(klass, message=nil)
@@ -256,14 +283,6 @@ module Ribbon::Intercom
       end
     end
 
-    def _encode_body(body)
-      Base64.strict_encode64(Marshal.dump(body))
-    end
-
-    def _encode_error(error)
-      Base64.strict_encode64(Marshal.dump(error))
-    end
-
     ##
     # Decodes the arguments.
     #

data/lib/ribbon/intercom/service/channel/stores/redis_store.rb

@@ -74,14 +74,24 @@ module Ribbon::Intercom
         private
 
         def _load_data(token)
-          if token_exists?(token) && (channel_data = @_redis.hgetall(_key_name(token)))
-            permissions = @_redis.smembers(_key_name(token, 'permissions'))
+          channel_data_future = nil
+          permissions_future  = nil
+          signing_keys_future = nil
+
+          @_redis.pipelined {
+            channel_data_future = @_redis.hgetall(_key_name(token))
+            permissions_future  = @_redis.smembers(_key_name(token, 'permissions'))
+            signing_keys_future = @_redis.hgetall(_key_name(token, 'signing_keys'))
+          }
 
-            signing_keys = Hash[
-              @_redis.hgetall(_key_name(token, 'signing_keys')).map { |key_id, data|
-                [key_id.to_i, Marshal.load(Base64.strict_decode64(data))]
-              }
-            ]
+          channel_data = channel_data_future.value
+
+          if channel_data && !channel_data.empty?
+            permissions = permissions_future.value
+
+            signing_keys = signing_keys_future.value.map { |key_id, data|
+              [key_id.to_i, Marshal.load(Base64.strict_decode64(data))]
+            }.to_h
 
             Utils.symbolize_keys(
               channel_data.merge(

data/lib/ribbon/intercom/utils.rb

@@ -3,10 +3,13 @@ require 'date'
 module Ribbon::Intercom
   module Utils
     autoload(:Signer, 'ribbon/intercom/utils/signer')
+    autoload(:MethodChain, 'ribbon/intercom/utils/method_chain')
     autoload(:Mixins, 'ribbon/intercom/utils/mixins')
 
     BASIC_TYPES = [
-      String, Symbol, TrueClass, FalseClass, Integer, Float, NilClass, Date, Time, DateTime
+      String, Symbol, TrueClass, FalseClass, Integer, Float, NilClass,
+      Date, Time, DateTime,
+      Hash, Array, Range
     ].freeze
 
     class << self

data/lib/ribbon/intercom/utils/method_chain.rb

@@ -0,0 +1,38 @@
+module Ribbon::Intercom
+  module Utils
+    class MethodChain
+      class << self
+        def begin(&block)
+          new(&block)
+        end
+      end # Class Methods
+
+      ##
+      # Need to override all public instance methods so they can be captured correctly.
+      public_instance_methods.each { |meth|
+        define_method(meth) { |*args|
+          _add_method(meth, *args)
+        }
+      }
+
+      def initialize(&block)
+        @_end_block = block
+      end
+
+      def end
+        @_end_block.call(@_methods)
+      end
+
+      private
+
+      def method_missing(meth, *args, &block)
+        _add_method(meth, *args)
+      end
+
+      def _add_method(meth, *args)
+        (@_methods ||= []) << [meth, *args]
+        self
+      end
+    end # MethodChain
+  end # Utils
+end # Ribbon::Intercom

data/lib/ribbon/intercom/version.rb

@@ -1,5 +1,5 @@
 module Ribbon
   module Intercom
-    VERSION = '0.3.4'
+    VERSION = '0.4.0'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ribbon-intercom
 version: !ruby/object:Gem::Version
-  version: 0.3.4
+  version: 0.4.0
 platform: ruby
 authors:
 - Robert Honer
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-19 00:00:00.000000000 Z
+date: 2015-05-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -172,6 +172,8 @@ files:
 - lib/ribbon/intercom/package.rb
 - lib/ribbon/intercom/packageable.rb
 - lib/ribbon/intercom/packageable/mixin.rb
+- lib/ribbon/intercom/packet.rb
+- lib/ribbon/intercom/packet/method_queue.rb
 - lib/ribbon/intercom/railtie.rb
 - lib/ribbon/intercom/service.rb
 - lib/ribbon/intercom/service/channel.rb
@@ -180,6 +182,7 @@ files:
 - lib/ribbon/intercom/service/channel/stores/redis_store.rb
 - lib/ribbon/intercom/service/channel/stores/store.rb
 - lib/ribbon/intercom/utils.rb
+- lib/ribbon/intercom/utils/method_chain.rb
 - lib/ribbon/intercom/utils/mixins.rb
 - lib/ribbon/intercom/utils/mixins/mock_safe.rb
 - lib/ribbon/intercom/utils/signer.rb