ably 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ea2c608bdda1c7910a086adf11b7d32854df487c
-  data.tar.gz: d490375a690b51efbe14ebc765ec7786b114a658
+  metadata.gz: b13770cd1f3131e42728090c7f7e7b28b56d02be
+  data.tar.gz: fe42558802cdccd07138ea9ce370e53091336988
 SHA512:
-  metadata.gz: 7d3801488036052b450c6e81cc824e5c223432c697642e3aebe0d8f27c77c2eb1784d84693b5d232110dc9080bd285b6f828094bb383e88d436069922b264bc3
-  data.tar.gz: 272c272b9beb386d6ae7ca33fd8ee4868cd7ff4d4e0fdd8951a5df65df3af465d586fd5a79325e509b49b7e17f88ca1ce9a5e757f06d976449fd322ecda88912
+  metadata.gz: 8795d186ce87c181ac86919760afc845ff49531e2946554b39ca30b8057a82018f57c59d0b22cf7f66270734b83e5adc8c9b8ed1dffb2ec9aee58a78c45f6eed
+  data.tar.gz: 46837150a1ae0f22675d25656772cb50f08e34b9cbd0d472f0a2ff12c069fe2d7229ac45f1f6b900dd78e08d384716dba3da3ba0f5fd7fd0bff688c60a9fdeca

data/lib/ably.rb

@@ -1,4 +1,4 @@
-%w(modules models).each do |namespace|
+%w(modules models util).each do |namespace|
   Dir.glob(File.expand_path("ably/#{namespace}/*.rb", File.dirname(__FILE__))).each do |file|
     require file
   end

data/lib/ably/exceptions.rb

@@ -34,5 +34,8 @@ module Ably
 
     # The token is invalid
     class InvalidToken < InvalidRequest; end
+
+    # Encryption or decryption related failures
+    class EncryptionError < StandardError; end
   end
 end

data/lib/ably/token.rb

@@ -1,4 +1,5 @@
 module Ably
+  # Authentication token issued by Ably in response to an token request
   class Token
     include Ably::Modules::Conversions
 
@@ -7,32 +8,52 @@ module Ably
       ttl:        60 * 60 # 1 hour
     }
 
+    # Buffer in seconds given to the use of a token prior to it being considered unusable
+    # For example, if buffer is 10s, the token can no longer be used for new requests 9s before it expires
     TOKEN_EXPIRY_BUFFER = 5
 
     def initialize(attributes)
       @attributes = attributes.clone.freeze
     end
 
+    # Unique token ID used to authenticate requests
+    #
+    # @return [String]
     def id
       attributes.fetch(:id)
     end
 
+    # Key ID used to create this token
+    #
+    # @return [String]
     def key_id
       attributes.fetch(:key)
     end
 
+    # Time the token was issued
+    #
+    # @return [Time]
     def issued_at
       as_time_from_epoch(attributes.fetch(:issued_at), granularity: :s)
     end
 
+    # Time the token expires
+    #
+    # @return [Time]
     def expires_at
       as_time_from_epoch(attributes.fetch(:expires), granularity: :s)
     end
 
+    # Capabilities assigned to this token
+    #
+    # @return [Hash]
     def capability
       attributes.fetch(:capability)
     end
 
+    # Optioanl client ID assigned to this token
+    #
+    # @return [String]
     def client_id
       attributes.fetch(:client_id)
     end
@@ -47,6 +68,8 @@ module Ably
     end
 
     # Returns true if token is expired or about to expire
+    #
+    # @return [Boolean]
     def expired?
       expires_at < Time.now + TOKEN_EXPIRY_BUFFER
     end

data/lib/ably/util/crypto.rb

@@ -0,0 +1,77 @@
+require 'msgpack'
+require 'openssl'
+
+module Ably::Util
+  class Crypto
+    DEFAULTS = {
+      algorithm: 'AES',
+      mode: 'CBC',
+      key_length: 128,
+      block_length: 16
+    }
+
+    attr_reader :options
+
+    def initialize(options = {})
+      raise ArgumentError, ":secret is required" unless options.has_key?(:secret)
+      @options = DEFAULTS.merge(options).freeze
+    end
+
+    def encrypt(payload)
+      cipher = openssl_cipher
+      cipher.encrypt
+      cipher.key = secret
+      iv = cipher.random_iv
+      cipher.iv = iv
+
+      iv << cipher.update(pack(payload)) << cipher.final
+    end
+
+    def decrypt(encrypted_payload_with_iv)
+      raise Ably::Exceptions::EncryptionError, "iv is missing" unless encrypted_payload_with_iv.length >= block_length*2
+
+      iv = encrypted_payload_with_iv.slice(0..15)
+      encrypted_payload = encrypted_payload_with_iv.slice(16..-1)
+
+      decipher = openssl_cipher
+      decipher.decrypt
+      decipher.key = secret
+      decipher.iv = iv
+
+      unpack(decipher.update(encrypted_payload) << decipher.final)
+    end
+
+    def random_key
+      openssl_cipher.random_key
+    end
+
+    def random_iv
+      openssl_cipher.random_iv
+    end
+
+    private
+    def pack(object)
+      object.to_msgpack
+    end
+
+    def unpack(msgpack_binary)
+      MessagePack.unpack(msgpack_binary)
+    end
+
+    def secret
+      options[:secret]
+    end
+
+    def block_length
+      options[:block_length]
+    end
+
+    def cipher_type
+      "#{options[:algorithm]}-#{options[:key_length]}-#{options[:mode]}"
+    end
+
+    def openssl_cipher
+      OpenSSL::Cipher.new(cipher_type)
+    end
+  end
+end

data/lib/ably/version.rb

@@ -1,3 +1,3 @@
 module Ably
-  VERSION = "0.1.3"
+  VERSION = "0.1.4"
 end

data/spec/acceptance/crypto.rb

@@ -0,0 +1,63 @@
+require 'spec_helper'
+
+describe Ably::Util::Crypto do
+  let(:secret) { SecureRandom.hex }
+  subject { Ably::Util::Crypto.new(secret: secret) }
+
+  context 'encrypts & decrypt' do
+    let(:string) { SecureRandom.hex }
+    let(:int) { SecureRandom.random_number(1_000_000_000) }
+    let(:float) { SecureRandom.random_number(1_000_000_000) * 0.1 }
+    let(:int64) { 15241578750190521 }
+    let(:hash) do
+      {
+        10 => nil,
+        'string' => 1,
+        'float' => 1.2
+      }
+    end
+    let(:array) { [string, int, float, int64, hash] }
+    let(:boolean) { true }
+    let(:nil) { nil }
+
+    specify 'a string' do
+      encrypted = subject.encrypt(string)
+      expect(subject.decrypt(encrypted)).to eql(string)
+    end
+
+    specify 'a int' do
+      encrypted = subject.encrypt(int)
+      expect(subject.decrypt(encrypted)).to eql(int)
+    end
+
+    specify 'a int64' do
+      encrypted = subject.encrypt(int64)
+      expect(subject.decrypt(encrypted)).to eql(int64)
+    end
+
+    specify 'a float' do
+      encrypted = subject.encrypt(float)
+      expect(subject.decrypt(encrypted)).to eql(float)
+    end
+
+    specify 'a hash' do
+      encrypted = subject.encrypt(hash)
+      expect(subject.decrypt(encrypted)).to eql(hash)
+    end
+
+    specify 'an array' do
+      encrypted = subject.encrypt(array)
+      expect(subject.decrypt(encrypted)).to eql(array)
+    end
+
+    specify 'a boolean' do
+      encrypted = subject.encrypt(boolean)
+      expect(subject.decrypt(encrypted)).to eql(boolean)
+    end
+
+    specify 'a nil object' do
+      encrypted = subject.encrypt(nil)
+      expect(subject.decrypt(encrypted)).to eql(nil)
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ably
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Lewis Marshall
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-26 00:00:00.000000000 Z
+date: 2014-09-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: eventmachine
@@ -192,7 +192,9 @@ files:
 - lib/ably/rest/models/presence_message.rb
 - lib/ably/rest/presence.rb
 - lib/ably/token.rb
+- lib/ably/util/crypto.rb
 - lib/ably/version.rb
+- spec/acceptance/crypto.rb
 - spec/acceptance/realtime/channel_spec.rb
 - spec/acceptance/rest/auth_spec.rb
 - spec/acceptance/rest/base_spec.rb
@@ -242,6 +244,7 @@ signing_key:
 specification_version: 4
 summary: A Ruby client library for ably.io, the real-time messaging service
 test_files:
+- spec/acceptance/crypto.rb
 - spec/acceptance/realtime/channel_spec.rb
 - spec/acceptance/rest/auth_spec.rb
 - spec/acceptance/rest/base_spec.rb