layer-api 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 18e06f067abf951b4ca63b477a8e1588ff26315e
-  data.tar.gz: 5e4a3538083b1bed84c05c9b630a601cb2fde88d
+  metadata.gz: 496391415565acba6e9457ee56385474741f3ba1
+  data.tar.gz: f849b844f3362d4285dfc329d8fa268af4dea07a
 SHA512:
-  metadata.gz: bcc79b9bde3ea41415d224e1f5598ac133b8189e3b189fe0f3c8ddb9e412eb24df39fecbd237eac2ae64b7bcaa9f7656e1993a183f1b4a7397a2dee7e3500794
-  data.tar.gz: 7b1a390f6ec9961a93cecd1e1c418f99e945f0e6577b9db4d30a0a1a8c314a6e485e51a46b84d6e52883d254a85472e0a7b0864ae5fe821bbaa0ad4b6d25d2cd
+  metadata.gz: d23bf3f10474ff0bbe727f28650b490a84459e1760d54e43457ed67df1f00a11d9ab06154aefe555f4bea2a132326f436fbd3a944946c30c83f76cb8ebf3d637
+  data.tar.gz: 41377bb6ff55bc0c127a56cd0634a32ccd4fde0af998c3982f55fe03dd8dbdae443feb05fbb6372b8d9d8761697d6e7833fc2c85d7bed1e04295ca2dee24c63f

data/README.md

@@ -28,11 +28,11 @@ Or install it yourself as:
 ## Usage
 
 ### Resources
-All client methods return  `Resource` objects or a collection of `Resource` objects. Every attribute from a resource can be accessed by calling attribute methods:
+All client methods return `Resource` objects or a collection of `Resource` objects. Every attribute from a resource can be accessed by calling attribute methods:
 
 ```ruby
 conversation = platform.conversations.find("fb2f3a48-523d-4449-a57f-c6651fc6612c")
-#<Layer::Resources::Conversation:0x007fdb18b44bf0 @attributes={...}>
+#<Layer::Resources::Conversation @attributes={...}>
 
 # Get the stripped uuid for any resource
 conversation.uuid
@@ -46,19 +46,19 @@ conversation.attributes
 # => {"id" => "fb2f3a48-523d-4449-a57f-c6651fc6612c", "url" => "https://api.layer.com/apps/<APP_ID>/conversations/fb2f3a48-523d-4449-a57f-c6651fc6612c", ...}
 ```
 
-### [Platform API](https://developer.layer.com/docs/platform)
-See the official [Platform API docs](https://developer.layer.com/docs/platform) for additional info.
+### [Platform](https://developer.layer.com/docs/platform)
+See the [Platform API docs](https://developer.layer.com/docs/platform) for additional info.
 
 #### Authentication/setup
 
 ```ruby
 platform = Layer::Platform::Client.new(api_token: "your_api_token", app_id: "your_app_id")
-# => #<Layer::Platform::Client:0x007fdb19844f30 @api_token="...", @app_id="...">
+# => #<Layer::Platform::Client @api_token="...", @app_id="...">
 ```
 If you have `ENV['LAYER_API_TOKEN']` and `ENV['LAYER_APP_ID']` environment variables setup, they will be used by default and don't need to be included:
 ```ruby
 platform = Layer::Platform::Client.new
-# => #<Layer::Platform::Client:0x007fdb19844f30 @api_token="...", @app_id="...">
+# => #<Layer::Platform::Client @api_token="...", @app_id="...">
 ```
 
 #### Retrieving Conversations ####
@@ -76,11 +76,11 @@ convs = user.conversations.list
 # For a user
 user = platform.users.find("user_id")
 conv = user.conversations.find("conversation_id")
-# => #<Layer::Resources::Conversation:0x007fdb18b44bf0 @attributes={...}>
+# => #<Layer::Resources::Conversation @attributes={...}>
 
 # or alternatively
 conv = platform.conversations.find("conversation_id")
-# => #<Layer::Resources::Conversation:0x007fdb18b44bf0 @attributes={...}>
+# => #<Layer::Resources::Conversation @attributes={...}>
 ```
 
 #### Creating Conversations ####
@@ -98,7 +98,7 @@ conversation = {
 }
 
 platform.conversations.create(conversation)
-# => #<Layer::Resources::Conversation:0x007fdb18b44bf0 @attributes={...}>
+# => #<Layer::Resources::Conversation @attributes={...}>
 ```
 
 #### Editing Conversations ####
@@ -149,7 +149,7 @@ message = {
 
 conv = platform.conversations.find("conversation_id")
 conv.messages.create(message)
-# => #<Layer::Resources::Message:0x007fdb18b44bf0 @attributes={...}>
+# => #<Layer::Resources::Message @attributes={...}>
 ```
 
 #### Retrieving Messages ####
@@ -172,12 +172,12 @@ conv.messages.list
 # From a specific user's perspective
 user = platform.users.find("user_id")
 messages = user.messages.find("message_id")
-# => #<Layer::Resources::Message:0x007fdb18b44bf0 @attributes={...}>
+# => #<Layer::Resources::Message @attributes={...}>
 
 # From the systems perspective
 conv = platform.conversations.find("conversation_id")
 messages = conv.messages.find("message_id")
-# => #<Layer::Resources::Message:0x007fdb18b44bf0 @attributes={...}>
+# => #<Layer::Resources::Message @attributes={...}>
 ```
 
 #### Deleting A Message
@@ -209,7 +209,7 @@ announcement = {
 }
 
 platform.announcements.create(announcement)
-# => #<Layer::Resources::Announcement:0x007fdb18b44bf0 @attributes={...}>
+# => #<Layer::Resources::Announcement @attributes={...}>
 ```
 
 #### Modifying A Users Block List ####
@@ -233,7 +233,7 @@ user.update(operations)
 user = platform.users.find("user_id")
 
 blocks = user.blocks.list
-# => [#<Layer::Resources::Block @attributes={...}>, [#<Layer::Resources::Block @attributes={...}>, ...]
+# => [#<Layer::Resources::Block>, [#<Layer::Resources::Block>, ...]
 ```
 
 #### Blocking Users
@@ -280,12 +280,76 @@ Make sure the following environment variables are set:
 ```ruby
 # Returns a valid signed identity token. #
 token = platform.generate_identity_token(user_id: "1234", nonce: "your_random_nonce")
-# => #<Layer::IdentityToken:0x007f89b4adb890
+# => #<Layer::IdentityToken:0x007f89b4adb890>
 
 token.to_s
 # => "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsInR.cCI6IkpXVCIsImN0eSI6ImxheWVyLWVpdDt2PTEiLCJraWQiOiJhNz.5YTE0MC02YzY3LTExZTUtYjM0Mi1jZGJmNDAwZTE5NDgifQ"
 ```
 
+### [Webhooks](https://developer.layer.com/docs/webhooks)
+See the [Webhooks API docs](https://developer.layer.com/docs/webhooks) for additional info.
+
+#### Authentication/setup
+
+```ruby
+client = Layer::Webhooks::Client.new(api_token: "your_api_token", app_id: "your_app_id")
+# => #<Layer::Webhooks::Client @api_token="...", @app_id="...">
+```
+If you have `ENV['LAYER_API_TOKEN']` and `ENV['LAYER_APP_ID']` environment variables setup, they will be used by default and don't need to be included:
+```ruby
+client = Layer::Webhooks::Client.new
+# => #<Layer::Webhooks::Client @api_token="...", @app_id="...">
+```
+
+#### Registering Webhooks
+
+```ruby
+client.webhooks.create(
+  version: "1.0",
+  target_url: "https://mydomain.com/my-webhook-endpoint",
+  events: ["conversation.created", "message.sent"],
+  secret: "1697f925ec7b1697f925ec7b",
+  config: {:key1=>"value1", :key2=>"value2"}
+)
+# => #<Layer::Resources::Webhook @attributes={...}>
+```
+
+#### Listing Webhooks
+
+```ruby
+client.webhooks.list
+# => [#<Layer::Resources::Webhook>, #<Layer::Resources::Webhook>, ...]
+```
+
+#### Retrieving Webhooks
+
+```ruby
+client.webhooks.find("webhook_id")
+# => #<Layer::Resources::Webhook @attributes={...}>
+```
+
+#### Activating Webhooks
+
+```ruby
+webhook = client.webhooks.find("webhook_id")
+webhook.activate
+```
+
+#### Deactivating Webhooks
+
+```ruby
+webhook = client.webhooks.find("webhook_id")
+webhook.deactivate
+```
+
+#### Deleting Webhooks
+
+```ruby
+webhook = client.webhooks.find("webhook_id")
+webhook.destroy
+```
+
+
 ## Development ##
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake rspec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/layer/api.rb

@@ -8,15 +8,20 @@ require "layer/errors"
 require "layer/resource"
 require "layer/resource_proxy"
 require "layer/identity_token"
+require "layer/base_client"
 
 # Platform
 require "layer/platform/client"
 
+# Webhooks
+require "layer/webhooks/client"
+
 # Resources
 require "layer/resources/conversation"
 require "layer/resources/message"
 require "layer/resources/announcement"
 require "layer/resources/user"
 require "layer/resources/block"
+require "layer/resources/webhook"
 
 require "layer/middleware/api_errors"

data/lib/layer/base_client.rb

@@ -0,0 +1,24 @@
+module Layer
+  class BaseClient
+    DEFAULT_HOST = "https://api.layer.com"
+
+    def client
+      @http_client ||= Layer::HttpClient.new(base_url, default_headers)
+    end
+
+    def strip_layer_prefix(string)
+      string.split("/").last if string
+    end
+
+    def default_headers
+      {
+        'Accept' => 'application/vnd.layer+json; version=1.0',
+        'Content-Type' => 'application/json'
+      }
+    end
+
+    def base_url
+      DEFAULT_HOST
+    end
+  end
+end

data/lib/layer/http_client.rb

@@ -2,18 +2,16 @@ require 'securerandom'
 
 module Layer
   class HttpClient
-    DEFAULT_HOST = "https://api.layer.com"
+    attr_reader :base_url, :default_headers
 
-    attr_reader :app_id, :api_token
-
-    def initialize(app_id, api_token)
-      @app_id = app_id
-      @api_token = api_token
+    def initialize(base_url, default_headers)
+      @base_url = base_url
+      @default_headers = default_headers
     end
 
     def connection
       @connection ||= Faraday.new(url: base_url) do |faraday|
-        faraday.headers = default_layer_headers
+        faraday.headers = default_headers
         faraday.request  :url_encoded
         faraday.adapter  Faraday.default_adapter
         faraday.use Middleware::ApiErrors
@@ -53,20 +51,8 @@ module Layer
       )
     end
 
-    def default_layer_headers
-      {
-        'Accept' => 'application/vnd.layer+json; version=1.0',
-        'Authorization' => "Bearer #{api_token}",
-        'Content-Type' => 'application/json'
-      }
-    end
-
     def layer_patch_header
       { 'Content-Type' => 'application/vnd.layer-patch+json' }
     end
-
-    def base_url
-      "#{DEFAULT_HOST}/apps/#{app_id}"
-    end
   end
 end

data/lib/layer/platform/client.rb

@@ -1,6 +1,6 @@
 module Layer
   module Platform
-    class Client
+    class Client < Layer::BaseClient
       attr_accessor :api_token, :app_id
 
       def initialize(options = {})
@@ -9,14 +9,6 @@ module Layer
         @app_id = strip_layer_prefix(id)
       end
 
-      def client
-        @http_client ||= Layer::HttpClient.new(@app_id, @api_token)
-      end
-
-      def strip_layer_prefix(string)
-        string.split("/").last if string
-      end
-
       def announcements
         Layer::ResourceProxy.new(client, nil, Layer::Resources::Announcement)
       end
@@ -33,6 +25,14 @@ module Layer
         Layer::IdentityToken.new(options)
       end
 
+      def default_headers
+        super.merge({"Authorization" => "Bearer #{api_token}"})
+      end
+
+      def base_url
+        "#{DEFAULT_HOST}/apps/#{app_id}"
+      end
+
       def inspect
         "#<#{self.class} api_token=\"#{@api_token}\" app_id=\"#{@app_id}\">"
       end

data/lib/layer/resources/webhook.rb

@@ -0,0 +1,13 @@
+module Layer
+  module Resources
+    class Webhook < Layer::Resource
+      def activate
+        client.post("#{url}/activate")
+      end
+
+      def deactivate
+        client.post("#{url}/deactivate")
+      end
+    end
+  end
+end

data/lib/layer/version.rb

@@ -1,5 +1,5 @@
 module Layer
   module Api
-    VERSION = "0.5.0"
+    VERSION = "0.6.0"
   end
 end

data/lib/layer/webhooks/client.rb

@@ -0,0 +1,36 @@
+module Layer
+  module Webhooks
+    class Client < Layer::BaseClient
+      attr_accessor :api_token, :app_id
+
+      def initialize(options = {})
+        id = options[:app_id] || ENV['LAYER_APP_ID']
+        @api_token = options[:api_token] || ENV['LAYER_API_TOKEN']
+        @app_id = strip_layer_prefix(id)
+      end
+
+      def webhooks
+        Layer::ResourceProxy.new(client, nil, Layer::Resources::Webhook)
+      end
+
+      def default_headers
+        super.merge(
+          {
+            "Authorization" => "Bearer #{api_token}",
+            "Accept" => "application/vnd.layer.webhooks+json; version=1.0"
+          }
+        )
+      end
+
+      def base_url
+        "#{DEFAULT_HOST}/apps/#{app_id}"
+      end
+
+      def inspect
+        "#<#{self.class} api_token=\"#{@api_token}\" app_id=\"#{@app_id}\">"
+      end
+
+      alias_method :to_s, :inspect
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: layer-api
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Jake Kelly
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-03-02 00:00:00.000000000 Z
+date: 2016-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -158,6 +158,7 @@ files:
 - bin/setup
 - layer-api.gemspec
 - lib/layer/api.rb
+- lib/layer/base_client.rb
 - lib/layer/errors.rb
 - lib/layer/http_client.rb
 - lib/layer/identity_token.rb
@@ -170,7 +171,9 @@ files:
 - lib/layer/resources/conversation.rb
 - lib/layer/resources/message.rb
 - lib/layer/resources/user.rb
+- lib/layer/resources/webhook.rb
 - lib/layer/version.rb
+- lib/layer/webhooks/client.rb
 homepage: https://github.com/cakejelly/layer-api
 licenses:
 - MIT