layer-ruby 0.3.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1175f3c645d381961648fee03212ff4148a4cce7
-  data.tar.gz: 57265f20d7c15ff918cd4e96b34c0211b1b8c488
+  metadata.gz: 6b2e92f9be129ac6265ff24ab73852387a9e438a
+  data.tar.gz: 1f3911782934d15e49f0feeb3964357acd28873c
 SHA512:
-  metadata.gz: 419b39243567daeaca8e3b18ede67330b460f8dd478b4851cb1afb6e4529af84f33807b618909e66d5e477caf9c9c01c25d77326a4cef8a2cad3c4b0cbe0d726
-  data.tar.gz: e9a09eb831bd7759f177397c8e9a9e9fd301c793f833dd68a9a2367d7d27156a282d5add4371b6dddbb5a2d58062a7c45dab8ca567440f15994b0e9417021160
+  metadata.gz: 57229aa42c27f78cef0f959c68d24299792cee2803142cfa304bab995a9c1268decd4b055abae6d8ed5c49ce014139de36129c9ba3c21d31a9d375a1266c0d46
+  data.tar.gz: 9681349bdb101b4ec80219bcc69990454353b8c9b9f72c33896e9673f555c7f932a5128655fe773a2131f7df060775aedc61700999338d35b2e7985ded664203

data/README.md

@@ -3,7 +3,7 @@
 [![Build Status](https://travis-ci.org/benedikt/layer-ruby.svg)](https://travis-ci.org/benedikt/layer-ruby)
 [![Gem Version](https://badge.fury.io/rb/layer-ruby.svg)](http://badge.fury.io/rb/layer-ruby)
 
-Ruby bindings for the [Layer Platform API](https://developer.layer.com/docs/platform). 
+Ruby bindings for the [Layer Platform API](https://developer.layer.com/docs/platform).
 
 ## Installation
 
@@ -23,7 +23,7 @@ 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) for details about the required payloads and responses.
 
 ### Configuration
 
@@ -50,13 +50,25 @@ To retrieve a existing conversation, just use `Conversation.find` passing it the
 conversation = Layer::Conversation.find('CONVERSATION_ID_HERE')
 ```
 
+### Updating Conversations
+
+To update a conversation, just update the conversation's attributes and call `save`.
+
+```ruby
+conversation = Layer::Conversation.find('CONVERSATION_ID_HERE')
+conversation.participants << 3
+conversation.metadata[:foo] = 'bar'
+conversation.save
+```
+
+
 ### 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' }])
+conversation.messages.create({ sender: { name: 'Server' }, parts: [{ body: 'Hello!', mime_type: 'text/plain' }]})
 ```
 
 ### Sending Announcements
@@ -64,7 +76,7 @@ conversation.messages.create({ sender: { name: 'Server' }, parts: [{ body: 'Hell
 You can send a announcements like this:
 
 ```ruby
-Layer::Announcement.create({ recipients: 'everyone', sender: { name: 'Server' }, parts: [{ body: 'Hello!', mime_type: 'text/plain' }])
+Layer::Announcement.create({ recipients: 'everyone', sender: { name: 'Server' }, parts: [{ body: 'Hello!', mime_type: 'text/plain' }]})
 ```
 
 ### Managing block lists
@@ -87,7 +99,7 @@ It's possible to create a new instance of `Layer::Client` and passing both the a
 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. 
+The client will not use any global configuration. You can pass the client as a second parameter to any operations (`create`, `find`) described above.
 
 ## Development
 
@@ -106,5 +118,4 @@ The gem is available as open source under the terms of the [MIT License](http://
 
 ## Related Work
 
-Check out the [layer-identity_token](https://github.com/dreimannzelt/layer-identity_token) gem to generate authentication tokens for the Layer SDK. 
-
+Check out the [layer-identity_token](https://github.com/dreimannzelt/layer-identity_token) gem to generate authentication tokens for the Layer SDK.

data/lib/layer.rb

@@ -1,5 +1,6 @@
 require 'layer/version'
 require 'layer/client'
+require 'layer/patch'
 require 'layer/operations'
 require 'layer/resource'
 require 'layer/relation_proxy'

data/lib/layer/client.rb

@@ -38,8 +38,10 @@ module Layer
       request(:post, *args)
     end
 
-    def patch(*args)
-      request(:patch, *args)
+    def patch(url, payload = {}, headers = {})
+      headers['Content-Type'] = 'application/vnd.layer-patch+json'
+
+      request(:patch, url, payload, headers)
     end
 
     def put(*args)

data/lib/layer/conversation.rb

@@ -2,6 +2,7 @@ module Layer
   class Conversation < Resource
     include Operations::Find
     include Operations::Create
+    include Operations::Patch
 
     def messages
       RelationProxy.new(self, Message, [Operations::Create])

data/lib/layer/operations.rb

@@ -2,3 +2,4 @@ require 'layer/operations/create'
 require 'layer/operations/find'
 require 'layer/operations/list'
 require 'layer/operations/delete'
+require 'layer/operations/patch'

data/lib/layer/operations/find.rb

@@ -15,7 +15,7 @@ module Layer
       end
 
       def reload
-        @attributes = client.get(url)
+        self.attributes = client.get(url)
         self
       end
 

data/lib/layer/operations/patch.rb

@@ -0,0 +1,23 @@
+module Layer
+  module Operations
+    module Patch
+
+      def save
+        client.patch(url, patch.operations)
+        patch.reset
+        true
+      end
+
+      def attributes=(attributes)
+        @attributes = Layer::Patch::Hash.new(patch, attributes)
+      end
+
+    private
+
+      def patch
+        @patch ||= Layer::Patch.new
+      end
+
+    end
+  end
+end

data/lib/layer/patch.rb

@@ -0,0 +1,62 @@
+require 'layer/patch/base'
+require 'layer/patch/array'
+require 'layer/patch/hash'
+
+module Layer
+  class Patch
+    def initialize(property = nil, parent = nil)
+      @property = property
+      @parent = parent
+    end
+
+    def add(property = nil, value)
+      operation(:add, property, value: value)
+    end
+
+    def add_index(property = nil, index, value)
+      operation(:add, property, index: index, value: value)
+    end
+
+    def remove(property = nil, value)
+      operation(:remove, property, value: value)
+    end
+
+    def remove_index(property = nil, index)
+      operation(:remove, property, index: index)
+    end
+
+    def set(property = nil, value)
+      operation(:set, property, value: value)
+    end
+
+    def replace(property = nil, value)
+      operation(:replace, property, value: value)
+    end
+
+    def delete(property)
+      operation(:delete, property)
+    end
+
+    def nested(property)
+      self.class.new(property, self)
+    end
+
+    def operations
+      @operations ||= @parent ? @parent.operations : []
+    end
+
+    def reset
+      @parent ? parent.reset : @operations = []
+    end
+
+  private
+
+    def operation(type, property = nil, options = {})
+      operations << options.merge(operation: type.to_s, property: expand_property(property))
+    end
+
+    def expand_property(property)
+      [@property, property].compact.join('.')
+    end
+  end
+end

data/lib/layer/patch/array.rb

@@ -0,0 +1,69 @@
+module Layer
+  class Patch
+    class Array < Base
+
+      def prepare_base(base)
+        base.each_with_index.map do |(value, index)|
+          wrap(index, value)
+        end
+      end
+
+      def []=(index, value)
+        patch.add_index(index, value)
+        super
+      end
+
+      def <<(value)
+        patch.add(value)
+        super
+      end
+      alias :push :<<
+
+      def unshift(value)
+        patch.add_index(0, value)
+        super
+      end
+
+      def concat(values)
+        values.each { |value| patch.add(value) }
+        super
+      end
+
+      def insert(offset, values)
+        values.each_with_index { |value, index| patch.add_index(offset + index, value) }
+        super
+      end
+
+      def clear
+        patch.replace([])
+        super
+      end
+
+      def delete_at(index)
+        patch.remove_index(index)
+        super
+      end
+
+      def delete(value)
+        patch.remove(value)
+        super
+      end
+
+      def pop
+        patch.remove_index(length)
+        super
+      end
+
+      def shift
+        patch.remove_index(0)
+        super
+      end
+
+      def replace(values)
+        patch.replace(values)
+        super
+      end
+
+    end
+  end
+end

data/lib/layer/patch/base.rb

@@ -0,0 +1,25 @@
+module Layer
+  class Patch
+    class Base < SimpleDelegator
+
+      attr_reader :patch
+
+      def initialize(patch, object)
+        @patch = patch
+        super(prepare_base(object))
+      end
+
+      def wrap(property, object)
+        case object
+        when ::Array
+          Layer::Patch::Array.new(patch.nested(property), object)
+        when ::Hash
+          Layer::Patch::Hash.new(patch.nested(property), object)
+        else
+          object
+        end
+      end
+
+    end
+  end
+end

data/lib/layer/patch/hash.rb

@@ -0,0 +1,55 @@
+module Layer
+  class Patch
+    class Hash < Base
+
+      def prepare_base(base)
+        base.each_pair do |key, value|
+          base[key] = wrap(key, value)
+        end
+      end
+
+      def []=(key, value)
+        patch.set(key, value)
+        super
+      end
+      alias :store :[]=
+
+      def clear
+        patch.replace({})
+        super
+      end
+
+      def delete(key)
+        patch.delete(key)
+        super
+      end
+
+      def delete_if(&block)
+        super do |key, value|
+          result = yield(key, value)
+          delete(key) if result
+          result
+        end
+      end
+      alias :reject! :delete_if
+
+      def shift
+        patch.delete(keys.first)
+        super
+      end
+
+      def replace(other_hash)
+        patch.replace(other_hash)
+        super
+      end
+
+      def merge!(other_hash)
+        other_hash.each_pair do |key, value|
+          patch.set(key, value)
+        end
+        super
+      end
+
+    end
+  end
+end

data/lib/layer/resource.rb

@@ -21,11 +21,11 @@ module Layer
       end
     end
 
-    attr_reader :client
+    attr_accessor :client, :attributes
 
     def initialize(attributes = {}, client = self.class.client)
-      @attributes = attributes
-      @client = client
+      self.attributes = attributes
+      self.client = client
     end
 
     def url
@@ -42,8 +42,6 @@ module Layer
 
   private
 
-    attr_reader :attributes
-
     def method_missing(method, *args, &block)
       if attributes.has_key?(method.to_s)
         attributes[method.to_s]

data/lib/layer/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: layer-ruby
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Benedikt Deicke
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-07-15 00:00:00.000000000 Z
+date: 2015-07-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -110,6 +110,11 @@ files:
 - lib/layer/operations/delete.rb
 - lib/layer/operations/find.rb
 - lib/layer/operations/list.rb
+- lib/layer/operations/patch.rb
+- lib/layer/patch.rb
+- lib/layer/patch/array.rb
+- lib/layer/patch/base.rb
+- lib/layer/patch/hash.rb
 - lib/layer/relation_proxy.rb
 - lib/layer/resource.rb
 - lib/layer/ruby.rb
@@ -140,3 +145,4 @@ signing_key:
 specification_version: 4
 summary: Ruby bindings for the Layer Platform API
 test_files: []
+has_rdoc: