ably 0.1.6 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bc321ac8e501652f72e08617651df2f90118a759
-  data.tar.gz: 9f9b3f5abedeba6a4ac79841a7e1d5d09bf2bc4c
+  metadata.gz: d814eac0ae04dc623743bbe5973e80a58662056d
+  data.tar.gz: 95426e76baeaee6fbc297031b83cc128e5bed688
 SHA512:
-  metadata.gz: cdd44c54e0015062c3ecd62bb39f2e03e2a5fe39118939bd7bd18d1bbddd3d774cd511634dac8273890d57b2fd2f2a2191df91016090a54e4e9ca8ffed3823c6
-  data.tar.gz: 4ef9786cc786a7d4b6b824bf5bc137b17d92180c0b3d201ba48cb3d6aa9cf85a56fb8b3639170a4d0ce4f41179e1b6780569e8727df761f5a9f384df20f4535c
+  metadata.gz: b660702de87dec06d7f982ea110d59310ba1f9a130be320bd2ec7a40f777b2e5452cfa4f97f6a08a0cf751646326f53196e7cf3a39c023ce55795583309ad4db
+  data.tar.gz: 8088bb09de07b180385a4e817827ef2d867ccb2c6645f55c68888bfaf932df7f2a7c2ec7392b3aa1471a5045beda59d0f93fa5775171ca99b1a1083b3fca2037

data/.gitignore

@@ -2,3 +2,5 @@ Gemfile.lock
 .yardoc
 doc/*
 pkg
+.bundle
+bin

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.1
+  - jruby-18mode # JRuby in 1.8 mode
+  - jruby-19mode # JRuby in 1.9 mode
+  - rbx-2.4.1
+

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2013 Lewis Marshall
+Copyright (c) 2014 Ably
 
 MIT License
 

data/README.md

@@ -1,5 +1,8 @@
 # [Ably](https://ably.io)
 
+[![Build Status](https://travis-ci.org/ably/ably-ruby.png)](https://travis-ci.org/ably/ably-ruby)
+[![Gem Version](https://badge.fury.io/rb/ably.svg)](http://badge.fury.io/rb/ably)
+
 A Ruby client library for [ably.io](https://ably.io), the real-time messaging service.
 
 ## Installation
@@ -60,7 +63,7 @@ channel.publish("greeting", "Hello World!")
 ```ruby
 client = Ably::Realtime.new(api_key: "xxxxx")
 channel = client.channel("test")
-channel.presence.enter(client_data: 'john.doe') do |presence|
+channel.presence.enter(data: 'john.doe') do |presence|
   presence.get #=> [Array of members present]
 end
 ```
@@ -106,6 +109,10 @@ client = Ably::Rest.new(api_key: "xxxxx")
 client.time #=> 2013-12-12 14:23:34 +0000
 ```
 
+## Dependencies
+
+If you only need to use the REST features of this library and do not want EventMachine as a dependency, then you should use the [Ably Ruby REST gem](https://rubygems.org/gems/ably-rest).
+
 ## Contributing
 
 1. Fork it

data/Rakefile

@@ -2,3 +2,13 @@ require "bundler/gem_tasks"
 
 require "yard"
 YARD::Rake::YardocTask.new
+
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+
+  task :default => :spec
+rescue LoadError
+  # no rspec available
+end

data/ably.gemspec

@@ -4,31 +4,31 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'ably/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "ably"
+  spec.name          = 'ably'
   spec.version       = Ably::VERSION
-  spec.authors       = ["Lewis Marshall", "Matthew O'Riordan"]
-  spec.email         = ["lewis@lmars.net", "matt@ably.io"]
+  spec.authors       = ['Lewis Marshall', "Matthew O'Riordan"]
+  spec.email         = ['lewis@lmars.net', 'matt@ably.io']
   spec.description   = %q{A Ruby client library for ably.io, the real-time messaging service}
   spec.summary       = %q{A Ruby client library for ably.io, the real-time messaging service}
-  spec.homepage      = "http://github.com/ably/ably-ruby"
-  spec.license       = "MIT"
+  spec.homepage      = 'http://github.com/ably/ably-ruby'
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files`.split($/)
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency "eventmachine", "~> 1.0"
-  spec.add_runtime_dependency "statesman", "~> 1.0.0.beta2"
-  spec.add_runtime_dependency "faraday", "~> 0.9"
-  spec.add_runtime_dependency "json"
-  spec.add_runtime_dependency "websocket-driver", "~> 0.3"
-  spec.add_runtime_dependency "msgpack", "~> 0.5"
+  spec.add_runtime_dependency 'eventmachine', '~> 1.0'
+  spec.add_runtime_dependency 'statesman', '~> 1.0.0'
+  spec.add_runtime_dependency 'faraday', '~> 0.9'
+  spec.add_runtime_dependency 'json'
+  spec.add_runtime_dependency 'websocket-driver', '~> 0.3'
+  spec.add_runtime_dependency 'msgpack-ably', '~> 0.5.10'
 
-  spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "redcarpet"
-  spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "yard"
-  spec.add_development_dependency "webmock"
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'redcarpet'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'yard'
+  spec.add_development_dependency 'webmock'
 end

data/lib/ably.rb

@@ -4,11 +4,12 @@
   end
 end
 
-require "ably/auth"
-require "ably/exceptions"
-require "ably/realtime"
-require "ably/rest"
-require "ably/version"
+require 'ably/auth'
+require 'ably/exceptions'
+require 'ably/logger'
+require 'ably/realtime'
+require 'ably/rest'
+require 'ably/version'
 
 # Ably is the base namespace for the Ably {Ably::Realtime Realtime} & {Ably::Rest Rest} client libraries.
 #

data/lib/ably/auth.rb

@@ -2,7 +2,7 @@ require 'json'
 require 'faraday'
 require 'securerandom'
 
-require "ably/rest/middleware/external_exceptions"
+require 'ably/rest/middleware/external_exceptions'
 
 module Ably
   # Auth is responsible for authentication with {https://ably.io Ably} using basic or token authentication
@@ -44,26 +44,26 @@ module Ably
       @auth_callback = auth_block if block_given?
 
       unless auth_options.kind_of?(Hash)
-        raise ArgumentError, "Expected auth_options to be a Hash"
+        raise ArgumentError, 'Expected auth_options to be a Hash'
       end
 
       if auth_options[:api_key] && (auth_options[:key_secret] || auth_options[:key_id])
-        raise ArgumentError, "api_key and key_id or key_secret are mutually exclusive. Provider either an api_key or key_id & key_secret"
+        raise ArgumentError, 'api_key and key_id or key_secret are mutually exclusive. Provider either an api_key or key_id & key_secret'
       end
 
       if auth_options[:api_key]
         api_key_parts = auth_options[:api_key].to_s.match(/(?<id>[\w_-]+\.[\w_-]+):(?<secret>[\w_-]+)/)
-        raise ArgumentError, "api_key is invalid" unless api_key_parts
+        raise ArgumentError, 'api_key is invalid' unless api_key_parts
         auth_options[:key_id] = api_key_parts[:id]
         auth_options[:key_secret] = api_key_parts[:secret]
       end
 
       if using_basic_auth? && !api_key_present?
-        raise ArgumentError, "api_key is missing. Either an API key, token, or token auth method must be provided"
+        raise ArgumentError, 'api_key is missing. Either an API key, token, or token auth method must be provided'
       end
 
       if has_client_id? && !api_key_present?
-        raise ArgumentError, "client_id cannot be provided without a complete API key. Key ID & Secret is needed to authenticate with Ably and obtain a token"
+        raise ArgumentError, 'client_id cannot be provided without a complete API key. Key ID & Secret is needed to authenticate with Ably and obtain a token'
       end
 
       @options.freeze
@@ -162,7 +162,7 @@ module Ably
 
       token_request = IdiomaticRubyWrapper(token_request)
 
-      response = client.post("/keys/#{token_request.fetch(:id)}/requestToken", token_request, send_auth_header: false)
+      response = client.post("/keys/#{token_request.fetch(:id)}/requestToken", token_request.hash, send_auth_header: false)
       body = IdiomaticRubyWrapper(response.body)
 
       Ably::Models::Token.new(body.fetch(:access_token))
@@ -199,7 +199,7 @@ module Ably
       request_key_id     = token_options.delete(:key_id) || key_id
       request_key_secret = token_options.delete(:key_secret) || key_secret
 
-      raise Ably::Exceptions::TokenRequestError, "Key ID and Key Secret are required to generate a new token request" unless request_key_id && request_key_secret
+      raise Ably::Exceptions::TokenRequestError, 'Key ID and Key Secret are required to generate a new token request' unless request_key_id && request_key_secret
 
       timestamp = if token_options[:query_time]
         client.time
@@ -294,7 +294,7 @@ module Ably
 
     # Basic Auth HTTP Authorization header value
     def basic_auth_header
-      raise Ably::Exceptions::InsecureRequestError, "Cannot use Basic Auth over non-TLS connections" unless client.use_tls?
+      raise Ably::Exceptions::InsecureRequestError, 'Cannot use Basic Auth over non-TLS connections' unless client.use_tls?
       "Basic #{encode64("#{api_key}")}"
     end
 
@@ -313,7 +313,7 @@ module Ably
 
     # Basic Auth params to authenticate the Realtime connection
     def basic_auth_params
-      raise Ably::Exceptions::InsecureRequestError, "Cannot use Basic Auth over non-TLS connections" unless client.use_tls?
+      raise Ably::Exceptions::InsecureRequestError, 'Cannot use Basic Auth over non-TLS connections' unless client.use_tls?
       # TODO: Change to key_secret when API is updated
       {
         key_id: key_id,
@@ -395,10 +395,7 @@ module Ably
         # Raise exceptions if response code is invalid
         builder.use Ably::Rest::Middleware::ExternalExceptions
 
-        setup_incoming_middleware builder
-
-        # Log HTTP requests if log level is DEBUG option set
-        builder.response :logger if client.log_level == Logger::DEBUG
+        setup_incoming_middleware builder, client.logger
 
         # Set Faraday's HTTP adapter
         builder.adapter Faraday.default_adapter

data/lib/ably/exceptions.rb

@@ -9,7 +9,7 @@ module Ably
     #   @return [String] HTTP status code of error
     # @!attribute [r] code
     #   @return [String] Ably specific error code
-    class Base < StandardError
+    class BaseAblyException < StandardError
       attr_reader :status, :code
       def initialize(message, status = nil, code = nil)
         super message
@@ -19,7 +19,23 @@ module Ably
     end
 
     # An invalid request was received by Ably
-    class InvalidRequest < Base; end
+    class InvalidRequest < BaseAblyException; end
+
+    # The token is invalid
+    class InvalidToken < BaseAblyException; end
+
+    # Ably Protocol message received that is invalid
+    class ProtocolError < BaseAblyException; end
+
+    # Encryption or Decryption failure
+    class CipherError < BaseAblyException; end
+
+    # Encoding or decoding failure
+    class EncoderError < BaseAblyException; end
+
+    # A generic Ably exception taht supports a status & code.
+    # See https://github.com/ably/ably-common/blob/master/protocol/errors.json for a list of Ably errors
+    class Standard < BaseAblyException; end
 
     # The HTTP request has returned a 500 error
     class ServerError < StandardError; end
@@ -35,18 +51,5 @@ module Ably
 
     # The token request could not be created
     class TokenRequestError < StandardError; end
-
-    # The token is invalid
-    class InvalidToken < Base; end
-
-    # Encryption or decryption related failures
-    class EncryptionError < StandardError; end
-
-    # Ably Protocol message received that is invalid
-    class ProtocolError < Base; end
-
-    # A generic Ably exception taht supports a status & code.
-    # See https://github.com/ably/ably-common/blob/master/protocol/errors.json for a list of Ably errors
-    class Standard < Base; end
   end
 end

data/lib/ably/logger.rb

@@ -0,0 +1,102 @@
+module Ably
+  # Logger unifies logging for #debug, #info, #warn, #error, and #fatal messages.
+  # A new Ably client uses this Logger and sets the appropriate log level.
+  # A custom Logger can be configured when instantiating the client, refer to the {Ably::Rest::Client} and {Ably::Realtime::Client} documentation
+  #
+  class Logger
+    extend Forwardable
+
+    # @param client        [Ably::Rest::Client,Ably::Realtime::Client] Rest or Realtime Ably client
+    # @param log_level     [Integer] {http://www.ruby-doc.org/stdlib-1.9.3/libdoc/logger/rdoc/Logger.html Ruby Logger} log level
+    # @param custom_logger [nil,Object] A custom logger can optionally be used instead of the,
+    #                      however it must provide a {http://www.ruby-doc.org/stdlib-1.9.3/libdoc/logger/rdoc/Logger.html Ruby Logger} compatible interface.
+    #
+    def initialize(client, log_level, custom_logger = nil)
+      @client        = client
+      @custom_logger = custom_logger
+      @logger        = custom_logger || default_logger
+      @log_level     = log_level
+
+      ensure_logger_interface_is_valid
+
+      @logger.level = log_level
+    end
+
+    # The logger used by this class, defaults to {http://www.ruby-doc.org/stdlib-1.9.3/libdoc/logger/rdoc/Logger.html Ruby Logger}
+    # @return {Object,Logger}
+    attr_reader :logger
+
+    # If a custom logger is being used with this Logger, this property is not nil
+    # @return {nil,Object}
+    attr_reader :custom_logger
+
+    # The log level ranging from DEBUG to FATAL, refer to http://www.ruby-doc.org/stdlib-1.9.3/libdoc/logger/rdoc/Logger.html
+    # @return {Integer}
+    attr_reader :log_level
+
+    def_delegators :logger, :fatal, :error, :warn, :info, :debug
+
+    private
+    attr_reader :client
+
+    def color(color_value, string)
+      "\033[#{color_value}m#{string}\033[0m"
+    end
+
+    def red(string)
+      color(31, string)
+    end
+
+    def magenta(string)
+      color(35, string)
+    end
+
+    def cyan(string)
+      color(36, string)
+    end
+
+    def connection_id
+      if realtime?
+        if client.connection.id
+          "[#{cyan(client.connection.id)}] "
+        else
+          "[ #{cyan('--')} ] "
+        end
+      end
+    end
+
+    def realtime?
+      client.respond_to?(:connection)
+    end
+
+    def default_logger
+      ::Logger.new(STDOUT).tap do |logger|
+        logger.formatter = proc do |severity, datetime, progname, msg|
+          severity = ::Logger::SEV_LABEL.index(severity) if severity.kind_of?(String)
+
+          formatted_date = if severity == ::Logger::DEBUG
+            datetime.strftime("%H:%M:%S.%L")
+          else
+            datetime.strftime("%Y-%m-%d %H:%M:%S.%L")
+          end
+
+          severity_label = if severity <= ::Logger::INFO
+            magenta(::Logger::SEV_LABEL[severity])
+          else
+            red(::Logger::SEV_LABEL[severity])
+          end
+
+          "#{formatted_date} #{severity_label} #{connection_id}#{msg}\n"
+        end
+      end
+    end
+
+    def ensure_logger_interface_is_valid
+      %w(fatal error warn info debug level level=).each do |method|
+        unless logger.respond_to?(method)
+          raise ArgumentError, "The custom Logger's interface does not provide the method '#{method}'"
+        end
+      end
+    end
+  end
+end

data/lib/ably/models/error_info.rb

@@ -31,7 +31,7 @@ module Ably::Models
     end
 
     def to_s
-      "Error: #{message} (code: #{code}, status_code: #{status_code})"
+      "Error: #{message} (code: #{code}, http status: #{status})"
     end
   end
 end

data/lib/ably/models/message.rb

@@ -25,6 +25,9 @@ module Ably::Models
   #   @return [String] The id of the publisher of this message
   # @!attribute [r] data
   #   @return [Object] The message payload. See the documentation for supported datatypes.
+  # @!attribute [r] encoding
+  #   @return [Object] The encoding for the message data. Encoding and decoding of messages is handled automatically by the client library.
+  #                    Therefore, the `encoding` attribute should always be nil unless an Ably library decoding error has occurred.
   # @!attribute [r] timestamp
   #   @return [Time] Timestamp when the message was received by the Ably the real-time service
   # @!attribute [r] id
@@ -34,6 +37,7 @@ module Ably::Models
   #
   class Message
     include Ably::Modules::ModelCommon
+    include Ably::Modules::Encodeable
     include EventMachine::Deferrable
 
     # {Message} initializer
@@ -44,10 +48,11 @@ module Ably::Models
     def initialize(hash_object, protocol_message = nil)
       @protocol_message = protocol_message
       @raw_hash_object  = hash_object
-      @hash_object      = IdiomaticRubyWrapper(hash_object.clone.freeze, stop_at: [:data])
+
+      set_hash_object hash_object
     end
 
-    %w( name client_id ).each do |attribute|
+    %w( name client_id encoding ).each do |attribute|
       define_method attribute do
         hash[attribute.to_sym]
       end
@@ -74,8 +79,11 @@ module Ably::Models
     end
 
     def as_json(*args)
-      raise RuntimeError, ":name is missing, cannot generate a valid Hash for Message" unless name
-      super
+      raise RuntimeError, ':name is missing, cannot generate a valid Hash for Message' unless name
+
+      hash.dup.tap do |message|
+        decode_binary_data_before_to_json message
+      end.as_json
     end
 
     # Assign this message to a ProtocolMessage before delivery to the Ably system
@@ -95,11 +103,13 @@ module Ably::Models
     # @return [Ably::Models::ProtocolMessage]
     # @api private
     def protocol_message
-      raise RuntimeError, "Message is not yet published with a ProtocolMessage. ProtocolMessage is nil" if @protocol_message.nil?
+      raise RuntimeError, 'Message is not yet published with a ProtocolMessage. ProtocolMessage is nil' if @protocol_message.nil?
       @protocol_message
     end
 
     private
+    attr_reader :raw_hash_object
+
     def protocol_message_index
       protocol_message.messages.index(self)
     end
@@ -111,5 +121,9 @@ module Ably::Models
     def message_serial
       protocol_message.message_serial
     end
+
+    def set_hash_object(hash)
+      @hash_object = IdiomaticRubyWrapper(hash.clone.freeze, stop_at: [:data])
+    end
   end
 end