layer-api 0.6.1 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: eb24c5c4996760ac0ce9e1efed6ccfb03ec9c878
-  data.tar.gz: ab91df8cb3337f8e792e6b15130a1d96b2cb2755
+  metadata.gz: d503cddd9b7bede59c73026f87bd04a5fad389e1
+  data.tar.gz: 107b52065cea9b15897c74ada0204e610714b336
 SHA512:
-  metadata.gz: 1b6e334ea799bc1bcb865e80713f4a2a14458538df4659b7b87bcdebe1460406858bc4b8109826434fec09a70b783501a813ce7b5f22fe9465d609143fa965a3
-  data.tar.gz: e71688cf635c519bff558fb42b99b4df9447ec1a2bdce6cfa62dc6267ad7811173107af219811423a5be518d64bedc2609d79463da36e1b1741aadd050741902
+  metadata.gz: 29142b474b962ef13c663705333c59a399df86d68d58599e03b2a62448bfd0456f402eec6ffeff158f7c46c270798d296a0c6c07b6f9e9c9d14bf7150e2fe4cd
+  data.tar.gz: 19f209e30eaba1b1e610336c30b74ff4667b80d3af2b9beb26e4beaab560b019f0b274a9507ce69c5e3257a1449afbe22565173dfb5b2d2c2bdd1c327952ce21

data/README.md

@@ -112,17 +112,41 @@ operations = [
 ]
 
 conv.update(operations)
-# => nil
+# => true
 ```
 #### Deleting Conversations ####
 
 ```ruby
 conv = platform.conversations.find("conversation_id")
 conv.destroy
-# => nil
+# => true
 
 ```
 
+#### Initiating a Rich Content Upload
+
+```ruby
+conv = platform.conversations.find("conversation_id")
+content = conv.content.create(mime_type: "image/png", file: File.open("image.png"))
+# => #<Layer::Resources::RichContent @attributes={...}>
+
+content.upload_url
+# => "https://www.googleapis.com/upload/storage/path/to/content"
+```
+
+#### Refreshing the download URL for a Content Object
+
+```ruby
+content = conv.content.find("content_id")
+# => #<Layer::Resources::RichContent @attributes={...}>
+
+content.download_url
+# => "http://google-testbucket.storage.googleapis.com/some/download/path"
+
+content.refresh_url
+# => "https://api.layer.com/apps/<APP_ID>/conversations/<CONVERSATION_ID>/content/<CONTENT_ID>"
+```
+
 #### Sending Messages ####
 
 ```ruby
@@ -185,7 +209,7 @@ messages = conv.messages.find("message_id")
 ```ruby
 conv = platform.conversations.find("conversation_id")
 conv.messages.find("message_id").destroy
-# => nil
+# => true
 ```
 
 #### Sending Announcements ####
@@ -224,7 +248,7 @@ operations = [
 ]
 
 user.update(operations)
-# => nil
+# => true
 ```
 
 #### Retrieving A Users Block List
@@ -259,16 +283,105 @@ owner.blocks.create(blocked)
 # using the blocked users id
 owner = platform.users.find("owner")
 owner.blocks.find("blocked_user").destroy
-# => nil
+# => true
 
 # using a User object
 owner = platform.users.find("owner")
 blocked = platform.users.find("blocked")
 
 owner.blocks.find(blocked).destroy
-# => nil
+# => true
+```
+
+#### Creating a User Identity
+
+```ruby
+identity = {
+  display_name: "Frodo the Dodo",
+  avatar_url: "http://sillylordoftheringspictures.com/frodo-riding-a-dodo.png",
+  first_name: "Frodo",
+  last_name: "Baggins",
+  phone_number: "13791379137",
+  email_address: "frodo@sillylordoftheringspictures.com",
+  metadata: {
+    level: "35",
+    race: "Dodo"
+  }
+}
+
+user = platform.users.find("user_id")
+user.create_identity(identity)
+# => true
+
 ```
 
+#### Retrieving a User's Identity
+
+```ruby
+user = platform.users.find("user_id")
+user.identity
+# => {"first_name"=>"Frodo", "phone_number"=>"13791379137", "email_address"=>"frodo@sillylordoftheringspictures.com", "display_name"=>"Frodo the Dodo", "user_id"=>"jake", "last_name"=>"Baggins", "metadata"=>{"race"=>"Dodo", "level"=>"35"}, "avatar_url"=>"http://sillylordoftheringspictures.com/frodo-riding-a-dodo.png"}
+```
+
+#### Updating an Identity
+
+```ruby
+operations = [
+  { operation: "set", property: "last_name", value: "Dodo" },
+  { operation: "set", property: "phone_number", value: "" },
+  { operation: "set", property: "metadata.level", value: "2" }
+]
+
+user.update_identity(operations)
+# => true
+```
+
+#### Replacing an identity
+
+```ruby
+identity = {
+  display_name: "Frodo the Dodo",
+  avatar_url: "http://sillylordoftheringspictures.com/frodo-riding-a-dodo.png",
+  first_name: "Frodo",
+  last_name: "Baggins",
+  phone_number: "13791379137",
+  email_address: "frodo@sillylordoftheringspictures.com",
+  metadata: {
+    level: "35",
+    race: "Dodo"
+  }
+}
+
+user.replace_identity(identity)
+# => true
+
+```
+
+#### Deleting a User's Identity
+
+```ruby
+user = platform.users.find("user_id")
+user.destroy_identity
+# => true
+```
+
+#### Setting a Users Badge
+
+```ruby
+user = platform.users.find("user_id")
+user.set_badge(10)
+# => true
+```
+
+#### Retrieving a Users Badge
+
+```ruby
+user = platform.users.find("user_id")
+user.badge
+# => { "external_unread_count" => 13, "unread_conversation_count" => 10, "unread_message_count" => 50 }
+```
+
+
 #### Generating Identity Tokens ####
 See: [the official authentication guide](https://developer.layer.com/docs/android/guides#authentication)
 

data/layer-api.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |spec|
   spec.license       = "MIT"
 
   spec.summary       = "A ruby toolkit for Layer's Web API's (https://developer.layer.com/docs)"
-  spec.description   = "Simple wrapper for the Layer's Web API's"
+  spec.description   = "Simple wrapper for Layer's Web API's"
   spec.homepage      = "https://github.com/cakejelly/layer-api"
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }

data/lib/layer/api.rb

@@ -23,5 +23,6 @@ require "layer/resources/announcement"
 require "layer/resources/user"
 require "layer/resources/block"
 require "layer/resources/webhook"
+require "layer/resources/rich_content"
 
 require "layer/middleware/api_errors"

data/lib/layer/http_client.rb

@@ -13,6 +13,7 @@ module Layer
       @connection ||= Faraday.new(url: base_url) do |faraday|
         faraday.headers = default_headers
         faraday.request  :url_encoded
+        faraday.request  :multipart
         faraday.adapter  Faraday.default_adapter
         faraday.use Middleware::ApiErrors
       end
@@ -22,6 +23,10 @@ module Layer
       call(:get, url, options)
     end
 
+    def put(url, options = {})
+      call(:put, url, options)
+    end
+
     def post(url, options = {})
       call(:post, url, options)
     end
@@ -36,7 +41,7 @@ module Layer
 
     def call(method, url, options = {})
       response = run_request(method, url, options)
-      response.body.empty? ? nil : JSON.parse(response.body)
+      response.body.empty? ? true : JSON.parse(response.body)
     end
 
     def run_request(method, url, options = {})

data/lib/layer/resource_proxy.rb

@@ -1,17 +1,20 @@
 module Layer
   class ResourceProxy
+    attr_accessor :url
+
     def initialize(client, base, resource)
       @client = client
       @base = base
       @resource = resource
+      @url = get_url(base, resource)
     end
 
-    def url
-      @base.nil? ? @resource.url : "#{@base.url}/#{@resource.url}"
+    def get_url(base, resource)
+      base.nil? ? resource.url : "#{base.url}/#{resource.url}"
     end
 
     def method_missing(method, *args, &block)
-      @resource.public_send(method, *([@client, url] + args), &block)
+      @resource.public_send(method, *([@client, @url] + args), &block)
     end
 
     def respond_to_missing?(method, include_private = false)

data/lib/layer/resources/conversation.rb

@@ -4,6 +4,16 @@ module Layer
       def messages
         Layer::ResourceProxy.new(client, self, Message)
       end
+
+      def content
+        proxy = Layer::ResourceProxy.new(client, self, RichContent)
+        proxy.url = content_url
+        proxy
+      end
+
+      def content_url
+        "conversations/#{uuid}/content"
+      end
     end
   end
 end

data/lib/layer/resources/rich_content.rb

@@ -0,0 +1,26 @@
+module Layer
+  module Resources
+    class RichContent < Layer::Resource
+      def self.create(client, url, params = {})
+        mime_type = params[:mime_type]
+        file = params[:file]
+
+        headers = {
+          "Upload-Content-Type" => mime_type,
+          "Upload-Content-Length" => file.size.to_s
+        }
+
+        response = client.post(url, body: params.to_json, headers: headers)
+        response.merge!("mime_type" => mime_type)
+
+        new(response, client).upload(file)
+      end
+
+      def upload(file)
+        file_header = { "Content-Length" => file.size.to_s }
+        client.put(upload_url, body: file, headers: file_header)
+        self
+      end
+    end
+  end
+end

data/lib/layer/resources/user.rb

@@ -16,6 +16,45 @@ module Layer
       def messages
         Layer::ResourceProxy.new(client, self, Layer::Resources::Message)
       end
+
+      def create_identity(params)
+        client.post(identity_url,  body: params.to_json)
+      end
+
+      def identity
+        client.get(identity_url)
+      end
+
+      def update_identity(params)
+        client.patch(
+          identity_url,
+          body: params.to_json,
+          headers: client.layer_patch_header
+        )
+      end
+
+      def replace_identity(params)
+        client.put(identity_url, body: params.to_json)
+      end
+
+      def destroy_identity
+        client.delete(identity_url)
+      end
+
+      def set_badge(badge_count)
+        body = { external_unread_count: badge_count }
+        client.put("#{url}/badge", body: body.to_json)
+      end
+
+      def badge
+        client.get("#{url}/badge")
+      end
+
+      private
+
+      def identity_url
+        "#{url}/identity"
+      end
     end
   end
 end

data/lib/layer/version.rb

@@ -1,5 +1,5 @@
 module Layer
   module Api
-    VERSION = "0.6.1"
+    VERSION = "0.7.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: layer-api
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.7.0
 platform: ruby
 authors:
 - Jake Kelly
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-04-10 00:00:00.000000000 Z
+date: 2016-04-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -140,7 +140,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.5.1
-description: Simple wrapper for the Layer's Web API's
+description: Simple wrapper for Layer's Web API's
 email:
 - jake.kelly10@gmail.com
 executables: []
@@ -170,6 +170,7 @@ files:
 - lib/layer/resources/block.rb
 - lib/layer/resources/conversation.rb
 - lib/layer/resources/message.rb
+- lib/layer/resources/rich_content.rb
 - lib/layer/resources/user.rb
 - lib/layer/resources/webhook.rb
 - lib/layer/version.rb