layer-ruby 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6b2e92f9be129ac6265ff24ab73852387a9e438a
-  data.tar.gz: 1f3911782934d15e49f0feeb3964357acd28873c
+  metadata.gz: 78be9a887246783d87ee5441bb6d713d7d11e0e9
+  data.tar.gz: c96c5872a9539077b4c86abc8fcda78bace25fcf
 SHA512:
-  metadata.gz: 57229aa42c27f78cef0f959c68d24299792cee2803142cfa304bab995a9c1268decd4b055abae6d8ed5c49ce014139de36129c9ba3c21d31a9d375a1266c0d46
-  data.tar.gz: 9681349bdb101b4ec80219bcc69990454353b8c9b9f72c33896e9673f555c7f932a5128655fe773a2131f7df060775aedc61700999338d35b2e7985ded664203
+  metadata.gz: 7d02be7b2d37304b8d8e18f4ebc8afba4b697c9272ef357e7bee0244f642294553565a09f59482fd04e1ea260c0ee90250b012bef36e7509aedc39d3eceb457b
+  data.tar.gz: f5ca37c2018d18ab8052b2b9df63e15b24d9e396cd92a504b8ac6a5b6ca5391987259969f5f8b7e790d91a960c88eaacd81af5992e904c76dcdf9f98a6d952ed

data/.gitignore

@@ -7,3 +7,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+.env

data/Gemfile

@@ -2,3 +2,8 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in layer-ruby.gemspec
 gemspec
+
+gem 'dotenv', '~> 2.0'
+gem 'layer-identity_token', '~> 0.0'
+gem 'guard-rspec', '~> 4.5'
+gem 'guard-yard', '~> 2.1'

data/Guardfile

@@ -14,3 +14,7 @@ guard :rspec, cmd: "bundle exec rspec" do
   ruby = dsl.ruby
   dsl.watch_spec_files_for(ruby.lib_files)
 end
+
+guard 'yard', :cli => '--reload' do
+  watch(%r{lib/.+\.rb})
+end

data/README.md

@@ -1,9 +1,10 @@
-# Layer Platform API
+# Ruby Client for Layer
 
-[![Build Status](https://travis-ci.org/benedikt/layer-ruby.svg)](https://travis-ci.org/benedikt/layer-ruby)
+[![Build Status](https://travis-ci.org/benedikt/layer-ruby.svg?branch=master)](https://travis-ci.org/benedikt/layer-ruby)
 [![Gem Version](https://badge.fury.io/rb/layer-ruby.svg)](http://badge.fury.io/rb/layer-ruby)
+[![Yard Docs](http://img.shields.io/badge/yard-docs-blue.svg)](http://rubydoc.info/gems/layer-ruby)
 
-Ruby bindings for the [Layer Platform API](https://developer.layer.com/docs/platform).
+Ruby client for the [Layer Platform API](https://developer.layer.com/docs/platform) and [Layer Client REST API](https://developer.layer.com/docs/client/rest).
 
 ## Installation
 
@@ -23,11 +24,11 @@ Or install it yourself as:
 
 ## Usage
 
-Please refer to the [Layer Platform API documentation](https://developer.layer.com/docs/platform) for details about the required payloads and responses.
+Please refer to the [Layer Platform API documentation](https://developer.layer.com/docs/platform) and [Layer Client REST API documentation](https://developer.layer.com/docs/client/rest) for details about the required payloads and responses.
 
 ### Configuration
 
-To use interact with the Layer Platform API, you need your Layer APP ID as well as a Layer Platform API Token. The gem reads both values from the `LAYER_APP_ID` and `LAYER_PLATFORM_TOKEN` environment variables. Alternatively you can specify the values by configuring the `Layer::Client` like this:
+To use the Layer Platform API, you need your Layer APP ID as well as a Layer Platform API Token. The gem reads both values from the `LAYER_APP_ID` and `LAYER_PLATFORM_TOKEN` environment variables. Alternatively you can specify the values by configuring the `Layer::Client` like this:
 
 ```ruby
 Layer::Client.configure do |config|
@@ -36,70 +37,34 @@ Layer::Client.configure do |config|
 end
 ```
 
-### Creating Conversations
-
-```ruby
-conversation = Layer::Conversation.create({ participants: ['1', '2'] })
-```
-
-### Retrieving Conversations
-
-To retrieve a existing conversation, just use `Conversation.find` passing it the conversation id:
-
-```ruby
-conversation = Layer::Conversation.find('CONVERSATION_ID_HERE')
-```
-
-### Updating Conversations
+### Using the gem with multiple applications at once
 
-To update a conversation, just update the conversation's attributes and call `save`.
+It's possible to create a new instance of `Layer::Client` and passing both the app id and the token to the initializer:
 
 ```ruby
-conversation = Layer::Conversation.find('CONVERSATION_ID_HERE')
-conversation.participants << 3
-conversation.metadata[:foo] = 'bar'
-conversation.save
+client = Layer::Client.new('YOUR_APP_ID_HERE', 'YOUR_PLATFORM_TOKEN_HERE')
 ```
 
+The client will not use any global configuration. You can pass the client as a second parameter to any operations (`create`, `find`) described above.
 
-### Sending Messages
-
-In order to send messages, you first have to load (or create) a Conversation. Afterwards you can send a message to the conversation like this:
-
-```ruby
-conversation = Layer::Conversation.find('CONVERSATION_ID_HERE')
-conversation.messages.create({ sender: { name: 'Server' }, parts: [{ body: 'Hello!', mime_type: 'text/plain' }]})
-```
-
-### Sending Announcements
+### Using the Layer Client REST API
 
-You can send a announcements like this:
+To use the Layer Client REST API, you need a way to generate identitiy tokens. You might want to use the [layer-identity_token](https://github.com/dreimannzelt/layer-identity_token) gem for that. Using this gem, you can create a new client using the REST API like this:
 
 ```ruby
-Layer::Announcement.create({ recipients: 'everyone', sender: { name: 'Server' }, parts: [{ body: 'Hello!', mime_type: 'text/plain' }]})
+client = Layer::Client.authenticate { |nonce| Layer::IdentityToken.new('user_id_here', nonce) }
 ```
 
-### Managing block lists
-
-Managing block lists is also possible:
+Afterwards, pass the client as an additional argument to the resource's methods:
 
 ```ruby
-user = Layer::User.find('user_id')
-user.blocks.all # Returns a list of blocks
-user.blocks.create({ user_id: 'other_user' }) # Adds the other user to the block list
-user.blocks.delete('other_user') # Removes the other user from the block list
-user.blocks.all.first.delete # Removes the first entry from the block list
+# Finds all conversations of the authenticated user
+Layer::Conversation.all(client)
 ```
 
-### Using the gem with multiple applications at once
+### Documentation
 
-It's possible to create a new instance of `Layer::Client` and passing both the app id and the token to the initializer:
-
-```ruby
-client = Layer::Client.new('YOUR_APP_ID_HERE', 'YOUR_PLATFORM_TOKEN_HERE')
-```
-
-The client will not use any global configuration. You can pass the client as a second parameter to any operations (`create`, `find`) described above.
+Please refer to [the full documentation](http://rubydoc.info/gems/layer-ruby) for details on how to use Announcements, Block Lists, Conversations, Messages, Rich Content, and WebHooks.
 
 ## Development
 

data/layer-ruby.gemspec

@@ -23,6 +23,6 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.10"
   spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec"
-  spec.add_development_dependency "guard-rspec"
+  spec.add_development_dependency "rspec", "~> 3.3"
+  spec.add_development_dependency "yard", "~> 0.8"
 end

data/lib/layer.rb

@@ -1,14 +1,31 @@
 require 'layer/version'
+require 'layer/exceptions'
 require 'layer/client'
 require 'layer/patch'
 require 'layer/operations'
 require 'layer/resource'
+require 'layer/resource_collection'
 require 'layer/relation_proxy'
 require 'layer/conversation'
+require 'layer/content'
 require 'layer/message'
 require 'layer/user'
 require 'layer/block'
 require 'layer/announcement'
+require 'layer/webhook'
+
+
+# @!macro [new] platform-api
+#   @note This is only available via the Platform API.
+
+# @!macro [new] rest-api
+#   @note This is only available via the REST API.
+#   @see file:README.md#label-Using+the+Layer+Client+REST+API Using the Client REST API
+
+# @!macro [new] various-apis
+#   @note This is available in both the REST and the Platform API. Please refer to the respective documentation to see which methods are available.
+#   @see file:README.md#label-Using+the+Layer+Client+REST+API Using the Client REST API
 
 module Layer
+
 end

data/lib/layer/announcement.rb

@@ -1,11 +1,17 @@
 module Layer
+  # @example
+  #   Layer::Announcement.create({ recipients: 'everyone', sender: { name: 'Server' }, parts: [{ body: 'Hello!', mime_type: 'text/plain' }]})
+  #
+  # @see https://developer.layer.com/docs/platform#send-an-announcement Layer Platform API Documentation about announcements
+  # @!macro platform-api
   class Announcement < Resource
     include Operations::Create
 
+    # @!parse extend Layer::Operations::Create::ClassMethods
+
     def sent_at
       Time.parse(attributes['sent_at'])
     end
 
   end
 end
-

data/lib/layer/block.rb

@@ -1,5 +1,19 @@
 module Layer
+  # Managing block lists is also possible:
+  #
+  # @example
+  #   user = Layer::User.find('user_id')
+  #   user.blocks.all # Returns a list of blocks
+  #   user.blocks.create({ user_id: 'other_user' }) # Adds the other user to the block list
+  #   user.blocks.delete('other_user') # Removes the other user from the block list
+  #   user.blocks.all.first.delete # Removes the first entry from the block list
+  #
+  # @see https://developer.layer.com/docs/platform#block-users Layer Platform API Documentation about block lists
+  # @!macro platform-api
   class Block < Resource
     include Operations::Delete
+
+    # @!parse extend Layer::Operations::Delete::ClassMethods
+
   end
 end

data/lib/layer/client.rb

@@ -1,6 +1,9 @@
 require 'rest-client'
 require 'securerandom'
 
+require 'layer/client/platform'
+require 'layer/client/rest'
+
 module Layer
   class Client
     class << self
@@ -21,13 +24,10 @@ module Layer
       def normalize_id(id)
         id.to_s.split('/').last
       end
-    end
 
-    attr_reader :app_id, :token
-
-    def initialize(app_id = self.class.app_id, token = self.class.token)
-      @app_id = self.class.normalize_id(app_id)
-      @token = token
+      def authenticate(app_id = self.app_id, &block)
+        Layer::Client::REST.new(app_id, &block)
+      end
     end
 
     def get(*args)
@@ -63,10 +63,9 @@ module Layer
   private
 
     def request(method, url, payload = {}, headers = {})
-      url = "https://api.layer.com/apps/#{app_id}#{url}" unless url.start_with?('https://api.layer.com')
+      url = "https://api.layer.com#{url}" unless url.start_with?('https://api.layer.com')
 
       headers = {
-        'Authorization' => "Bearer #{token}",
         'Accept' => 'application/vnd.layer+json; version=1.0',
         'Content-Type' => 'application/json',
         'If-None-Match' => SecureRandom.uuid
@@ -76,6 +75,8 @@ module Layer
 
       response = RestClient::Request.execute(method: method, url: url, payload: payload, headers: headers)
       response.empty? ? nil : JSON.parse(response)
+    rescue RestClient::Exception
+      raise Layer::Exceptions::Exceptions.build_exception($!)
     end
 
   end

data/lib/layer/client/platform.rb

@@ -0,0 +1,22 @@
+module Layer
+  class Client
+    class Platform < Layer::Client
+
+      attr_reader :app_id, :token
+
+      def initialize(app_id = self.class.app_id, token = self.class.token)
+        @app_id = self.class.normalize_id(app_id)
+        @token = token
+      end
+
+    private
+
+      def request(method, url, payload = {}, headers = {})
+        url = "https://api.layer.com/apps/#{app_id}#{url}" unless url.start_with?('https://api.layer.com')
+        headers['Authorization'] ||= "Bearer #{token}"
+
+        super
+      end
+    end
+  end
+end

data/lib/layer/client/rest.rb

@@ -0,0 +1,41 @@
+module Layer
+  class Client
+    class REST < Layer::Client
+
+      def self.authenticate(app_id, nonce = nil)
+        client = Layer::Client.new
+
+        nonce ||= client.post('/nonces')['nonce']
+
+        identity_token = yield(nonce)
+
+        response = client.post('/sessions', { identity_token: identity_token, app_id: app_id })
+        response['session_token']
+      end
+
+      attr_reader :token, :app_id, :block
+
+      def initialize(app_id = self.class.app_id, &block)
+        @app_id = self.class.normalize_id(app_id)
+        @block = block
+        authenticate
+      end
+
+    private
+
+      def request(method, url, payload = {}, headers = {})
+        url = "https://api.layer.com#{url}" unless url.start_with?('https://api.layer.com')
+        headers['Authorization'] ||= "Layer session-token=\"#{token}\""
+
+        super
+      rescue Layer::Exceptions::Exceptions::AuthenticationRequired => exception
+        authenticate(exception.response_json['data']['nonce'])
+        retry
+      end
+
+      def authenticate(nonce = nil)
+        @token = self.class.authenticate(app_id, nonce, &block)
+      end
+    end
+  end
+end

data/lib/layer/content.rb

@@ -0,0 +1,50 @@
+module Layer
+  # @example
+  #   content = Layer::Content.create('image/png', File.open('photo.png'))
+  #
+  #   message = Layer::Message.create({
+  #     sender: { name: 'Server' },
+  #     parts: [
+  #       { body: content.to_json, mime_type: content.mime_type }
+  #     ]
+  #   })
+  #
+  # @see https://developer.layer.com/docs/client/rest#rich-content Layer REST API documentation about rich content
+  # @!macro rest-api
+  class Content < Resource
+    include Operations::Create
+    include Operations::Find
+
+    # @!parse extend Layer::Operations::Create::ClassMethods
+    # @!parse extend Layer::Operations::Find::ClassMethods
+
+    def self.create(mime_type, file, client = self.client)
+      response = client.post(url, {}, headers = {
+        'Upload-Content-Type' => mime_type,
+        'Upload-Content-Length' => file.size
+      })
+
+      attributes = response.merge('size' => file.size)
+
+      from_response(attributes, client).tap do |content|
+        content.upload(file)
+      end
+    end
+
+    def self.url
+      '/content'
+    end
+
+    def upload(file)
+      RestClient.put(upload_url, file)
+    end
+
+    def url
+      attributes['refresh_url'] || "#{self.class.url}/#{Layer::Client.normalize_id(id)}"
+    end
+
+    def to_json(*args)
+      { id: id, size: size }.to_json(*args)
+    end
+  end
+end

data/lib/layer/conversation.rb

@@ -1,20 +1,82 @@
 module Layer
+  # @example Creating a new conversation
+  #   conversation = Layer::Conversation.create({ participants: ['1', '2'] })
+  #
+  # @example Finding an existing conversation
+  #   conversation = Layer::Conversation.find('CONVERSATION_ID_HERE')
+  #
+  # @example Updating an existing conversation
+  #   conversation = Layer::Conversation.find('CONVERSATION_ID_HERE')
+  #   conversation.participants << 3
+  #   conversation.metadata[:foo] = 'bar'
+  #   conversation.save
+  #
+  # @see https://developer.layer.com/docs/platform#retrieving-conversations Layer Platform API Documentation about conversations
+  # @see https://developer.layer.com/docs/client/rest#conversations Layer REST API Documentation about conversations
+  # @!macro various-apis
   class Conversation < Resource
     include Operations::Find
+    include Operations::Paginate
     include Operations::Create
+    include Operations::Delete
     include Operations::Patch
 
+    # @!parse extend Layer::Operations::Find::ClassMethods
+    # @!parse extend Layer::Operations::Paginate::ClassMethods
+    # @!parse extend Layer::Operations::Create::ClassMethods
+    # @!parse extend Layer::Operations::Delete::ClassMethods
+
+    # Destroys the conversation with the given id for all participants
+    #
+    # @param [String] id of the conversation to destroy
+    # @!macro rest-api
+    def self.destroy(id, client = self.client)
+      id = Layer::Client.normalize_id(id)
+      client.delete("#{url}/#{id}", {}, { params: { destroy: true } })
+    end
+
+    # Returns the converations messages
+    #
+    # @return [Layer::RelationProxy] the conversation's messages
+    # @!macro various-apis
     def messages
-      RelationProxy.new(self, Message, [Operations::Create])
+      RelationProxy.new(self, Message, [Operations::Create, Operations::Paginate, Operations::Find])
+    end
+
+    # Returns the conversations metadata
+    #
+    # @return [Layer::Patch::Hash] the metadata hash
+    def metadata
+      attributes['metadata'] ||= {}
     end
 
+    # Returns the conversations metadata
+    #
+    # @return [Layer::Patch::Array] the participants array
+    def participants
+      attributes['participants'] ||= []
+    end
+
+    # Whether the conversation is distinct
+    #
+    # @return [Boolean] whether the conversation is distinct
     def distinct?
       attributes['distinct']
     end
 
+    # Returns the time the conversation was created at
+    #
+    # @return [Time] the time the conversation was created at
     def created_at
       Time.parse(attributes['created_at'])
     end
 
+    # Destroys the conversation for all participants
+    #
+    # @!macro rest-api
+    def destroy
+      client.delete(url, {}, { params: { destroy: true } })
+    end
+
   end
 end

data/lib/layer/exceptions.rb

@@ -0,0 +1,52 @@
+module Layer
+  module Exceptions
+
+    def self.build_exception(original_exception)
+      identifier = JSON.parse(original_exception.http_body)['id']
+      identifier.gsub!(/(?:_|(\/)|^)([a-z\d]*)/i) { $2.capitalize }
+
+      exception = const_get(identifier) rescue Exception
+      exception.new(original_exception)
+    rescue
+      original_exception
+    end
+
+    class Exception < RuntimeError
+      attr_reader :original_exception
+
+      def initialize(original_exception = nil)
+        @original_exception = original_exception
+      end
+
+      def message
+        "#{original_exception.message}\n\n#{JSON.pretty_generate(response_json)}\n\n"
+      end
+
+      def response_json
+        JSON.parse(original_exception.http_body)
+      end
+    end
+
+    class ClientException < Exception; end
+    class ServiceUnavailable < ClientException; end
+    class InvalidAppId< ClientException; end
+    class InvalidRequestId < ClientException; end
+    class AuthenticationRequired < ClientException; end
+    class AppSuspended < ClientException; end
+    class UserSuspended < ClientException; end
+    class RateLimitExceeded < ClientException; end
+    class RequestTimeout < ClientException; end
+    class InvalidOperation < ClientException; end
+    class InvalidRequest < ClientException; end
+    class InvalidEndpoint < ClientException; end
+    class InvalidHeader < ClientException; end
+
+    class ResourceException < Exception; end
+    class AccessDenied < ResourceException; end
+    class NotFound < ResourceException; end
+    class ObjectDeleted < ResourceException; end
+    class MissingProperty < ResourceException; end
+    class InvalidProperty < ResourceException; end
+    class Conflict < ResourceException; end
+  end
+end

data/lib/layer/message.rb

@@ -1,13 +1,51 @@
 module Layer
+  # @example Sending messages
+  #   conversation = Layer::Conversation.find('CONVERSATION_ID_HERE')
+  #   conversation.messages.create({ sender: { name: 'Server' }, parts: [{ body: 'Hello!', mime_type: 'text/plain' }]})
+  #
+  # @see https://developer.layer.com/docs/platform#send-a-message Layer Platform API Documentation about messages
+  # @see https://developer.layer.com/docs/client/rest#messages Layer REST API Documentation about messages
+  # @see Layer::Content Sending rich content using Layer::Content
+  #
+  # @!macro various-apis
   class Message < Resource
+    include Operations::Find
 
+    # @!parse extend Layer::Operations::Find::ClassMethods
+
+    # Returns the conversation this message belongs to
+    #
+    # @return [Layer::Conversation] the message's conversation
     def conversation
       Conversation.from_response(attributes['conversation'], client)
     end
 
+    # Returns the time the message was sent at
+    #
+    # @return [Time] the time the message was sent at
     def sent_at
       Time.parse(attributes['sent_at'])
     end
 
+    # Marks the message as read by the current user
+    #
+    # @!macro rest-api
+    def read!
+      client.post(receipts_url, { type: 'read' })
+    end
+
+    # Marks the message as delivered to the current user
+    # @!macro rest-api
+    def delivered!
+      client.post(receipts_url, { type: 'delivery' })
+    end
+
+    # The endpoint to send read and delivered receipts to
+    #
+    # @return [String] the url of the endpoint
+    # @!macro rest-api
+    def receipts_url
+      attributes['receipts_url'] || "#{url}/receipts"
+    end
   end
 end

data/lib/layer/operations.rb

@@ -1,5 +1,6 @@
 require 'layer/operations/create'
 require 'layer/operations/find'
 require 'layer/operations/list'
+require 'layer/operations/paginate'
 require 'layer/operations/delete'
 require 'layer/operations/patch'

data/lib/layer/operations/create.rb

@@ -3,12 +3,19 @@ module Layer
     module Create
 
       module ClassMethods
+        # Creates the resource with the given attributes
+        #
+        # @param attributes [Hash] the resource's attributes
+        # @param client [Layer::Client] the client to use to make this request
+        # @return [Layer::Resource] the created resource
+        # @raise [Layer::Exceptions::Exception] a subclass of Layer::Exceptions::Exception describing the error
         def create(attributes = {}, client = self.client)
           response = client.post(url, attributes)
           from_response(response, client)
         end
       end
 
+      # @!visibility private
       def self.included(base)
         base.extend(ClassMethods)
       end

data/lib/layer/operations/delete.rb

@@ -3,16 +3,25 @@ module Layer
     module Delete
 
       module ClassMethods
+        # Deletes the resource with the given id
+        #
+        # @param id [String] the resource's id
+        # @param client [Layer::Client] the client to use to make this request
+        # @raise [Layer::Exceptions::Exception] a subclass of Layer::Exceptions::Exception describing the error
         def delete(id, client = self.client)
           id = Layer::Client.normalize_id(id)
           client.delete("#{url}/#{id}")
         end
       end
 
+      # @!visibility private
       def self.included(base)
         base.extend(ClassMethods)
       end
 
+      # Deletes the resource
+      #
+      # @raise [Layer::Exceptions::Exception] a subclass of Layer::Exceptions::Exception describing the error
       def delete
         client.delete(url)
       end

data/lib/layer/operations/find.rb

@@ -3,6 +3,12 @@ module Layer
     module Find
 
       module ClassMethods
+        # Finds the resource with the given id
+        #
+        # @param id [String] the resource's id
+        # @param client [Layer::Client] the client to use to make this request
+        # @return [Layer::Resource] the found resource
+        # @raise [Layer::Exceptions::Exception] a subclass of Layer::Exceptions::Exception describing the error
         def find(id, client = self.client)
           id = Layer::Client.normalize_id(id)
           response = client.get("#{url}/#{id}")
@@ -10,10 +16,15 @@ module Layer
         end
       end
 
+      # @!visibility private
       def self.included(base)
         base.extend(ClassMethods)
       end
 
+      # Reloads the resource
+      #
+      # @return [Layer::Resource] the resource itself
+      # @raise [Layer::Exceptions::Exception] a subclass of Layer::Exceptions::Exception describing the error
       def reload
         self.attributes = client.get(url)
         self

data/lib/layer/operations/list.rb

@@ -3,12 +3,18 @@ module Layer
     module List
 
       module ClassMethods
+        # Finds all resources
+        #
+        # @param client [Layer::Client] the client to use to make this request
+        # @return [Enumerable] the found resources
+        # @raise [Layer::Exceptions::Exception] a subclass of Layer::Exceptions::Exception describing the error
         def all(client = self.client)
           response = client.get(url)
           response.map { |attributes| from_response(attributes, client) }
         end
       end
 
+      # @!visibility private
       def self.included(base)
         base.extend(ClassMethods)
       end

data/lib/layer/operations/paginate.rb

@@ -0,0 +1,23 @@
+module Layer
+  module Operations
+    module Paginate
+
+      module ClassMethods
+        # Finds all resources from a paginated endpoint
+        #
+        # @param client [Layer::Client] the client to use to make this request
+        # @return [Layer::ResourceCollection] the found resources
+        # @raise [Layer::Exceptions::Exception] a subclass of Layer::Exceptions::Exception describing the error
+        def all(client = self.client)
+          Layer::ResourceCollection.new(self, client)
+        end
+      end
+
+      # @!visibility private
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+
+    end
+  end
+end

data/lib/layer/operations/patch.rb

@@ -2,12 +2,20 @@ module Layer
   module Operations
     module Patch
 
+      # Creates the resource with the given attributes
+      #
+      # @return [Boolean] whether saving was successful
+      # @raise [Layer::Exceptions::Exception] a subclass of Layer::Exceptions::Exception describing the error
       def save
         client.patch(url, patch.operations)
         patch.reset
         true
       end
 
+      # Updates the resource's attributes to the given ones
+      #
+      # @param [Hash] attributes the new attributes
+      # @return [Layer::Patch::Hash] the resources new attributes
       def attributes=(attributes)
         @attributes = Layer::Patch::Hash.new(patch, attributes)
       end

data/lib/layer/patch/hash.rb

@@ -10,7 +10,7 @@ module Layer
 
       def []=(key, value)
         patch.set(key, value)
-        super
+        super(key, wrap(key, value))
       end
       alias :store :[]=
 

data/lib/layer/relation_proxy.rb

@@ -7,7 +7,7 @@ module Layer
       @resource_type = resource_type
       @base = base
 
-      operations.each { |operation| singleton_class.include(operation::ClassMethods) }
+      operations.each { |operation| singleton_class.send(:include, operation::ClassMethods) }
 
       instance_eval(&block) if block_given?
     end

data/lib/layer/resource.rb

@@ -17,7 +17,7 @@ module Layer
       end
 
       def client
-        @client ||= Client.new
+        @client ||= Client::Platform.new
       end
     end
 
@@ -29,7 +29,7 @@ module Layer
     end
 
     def url
-      attributes['url']
+      attributes['url'] || (id && "#{self.class.url}/#{Layer::Client.normalize_id(id)}")
     end
 
     def id
@@ -37,13 +37,18 @@ module Layer
     end
 
     def respond_to_missing?(method, include_private = false)
-      attributes.has_key?(method.to_s) || super
+      attribute = method.to_s.sub(/=$/, '')
+
+      attributes.has_key?(attribute) || super
     end
 
   private
 
     def method_missing(method, *args, &block)
-      if attributes.has_key?(method.to_s)
+      if method.to_s =~ /=$/
+        attribute = method.to_s.sub(/=$/, '')
+        attributes[attribute] = args.first
+      elsif attributes.has_key?(method.to_s)
         attributes[method.to_s]
       else
         super

data/lib/layer/resource_collection.rb

@@ -0,0 +1,30 @@
+module Layer
+  class ResourceCollection < Enumerator
+
+    def initialize(resource, client)
+      @resource = resource
+      @client = client
+      @params = { page_size: 100 }
+
+      super() do |yielder|
+        while response = next_page
+          response.map do |attributes|
+            yielder << resource.from_response(attributes, client)
+          end
+        end
+      end
+    end
+
+  private
+
+    attr_reader :resource, :client, :params
+
+    def next_page
+      response = client.get(resource.url, {}, { params: params })
+      return nil if response.empty?
+      params[:from_id] = Layer::Client.normalize_id(response.last['id'])
+      response
+    end
+
+  end
+end

data/lib/layer/version.rb

@@ -1,3 +1,3 @@
 module Layer
-  VERSION = '0.4.1'
+  VERSION = '0.5.0'
 end

data/lib/layer/webhook.rb

@@ -0,0 +1,59 @@
+module Layer
+  # @example
+  #   webhook = Layer::Webhook.create({
+  #     target_config: { foo: :bar },
+  #     secret: 'my-secret',
+  #     event_types: ['message.sent'],
+  #     target_url: 'http://example.com/layer/webhook'
+  #   })
+  # @see https://gist.github.com/vtrehan/9ef1e16db5e74305ddf3 Layer Webhook documentation (Prerelease)
+  # @note This feature is still in beta at Layer. Please contact Layer to enable webhooks for your account.
+  #
+  # @!macro platform-api
+  class Webhook < Resource
+    include Operations::Find
+    include Operations::List
+    include Operations::Create
+    include Operations::Delete
+
+    # @!parse extend Layer::Operations::Find::ClassMethods
+    # @!parse extend Layer::Operations::List::ClassMethods
+    # @!parse extend Layer::Operations::Create::ClassMethods
+    # @!parse extend Layer::Operations::Delete::ClassMethods
+
+    # Activate this webhook
+    def activate!
+      client.post("#{url}/activate")
+    end
+
+    # Deactivate this webhook
+    def deactivate!
+      client.post("#{url}/deactivate")
+    end
+
+    # Check if this webhook is unverified
+    # @return [Boolean] whether the webhook is unverified
+    def unverified?
+      status == 'unverified'
+    end
+
+    # Check if this webhook is active
+    # @return [Boolean] whether the webhook is active
+    def active?
+      status == 'active'
+    end
+
+    # Check if this webhook is inactive
+    # @return [Boolean] whether the webhook is inactive
+    def inactive?
+      status == 'inactive'
+    end
+
+    # Returns the time the webhook was created at
+    # @return [Time] the time the webhook was created at
+    def created_at
+      Time.parse(attributes['created_at'])
+    end
+
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: layer-ruby
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Benedikt Deicke
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-07-29 00:00:00.000000000 Z
+date: 2015-11-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -56,30 +56,30 @@ dependencies:
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.3'
 - !ruby/object:Gem::Dependency
-  name: guard-rspec
+  name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.8'
 description: Ruby bindings for the Layer Platform API
 email:
 - benedikt@benediktdeicke.com
@@ -103,13 +103,18 @@ files:
 - lib/layer/announcement.rb
 - lib/layer/block.rb
 - lib/layer/client.rb
+- lib/layer/client/platform.rb
+- lib/layer/client/rest.rb
+- lib/layer/content.rb
 - lib/layer/conversation.rb
+- lib/layer/exceptions.rb
 - lib/layer/message.rb
 - lib/layer/operations.rb
 - lib/layer/operations/create.rb
 - lib/layer/operations/delete.rb
 - lib/layer/operations/find.rb
 - lib/layer/operations/list.rb
+- lib/layer/operations/paginate.rb
 - lib/layer/operations/patch.rb
 - lib/layer/patch.rb
 - lib/layer/patch/array.rb
@@ -117,9 +122,11 @@ files:
 - lib/layer/patch/hash.rb
 - lib/layer/relation_proxy.rb
 - lib/layer/resource.rb
+- lib/layer/resource_collection.rb
 - lib/layer/ruby.rb
 - lib/layer/user.rb
 - lib/layer/version.rb
+- lib/layer/webhook.rb
 homepage: https://github.com/benedikt/layer-ruby
 licenses:
 - MIT