A ruby toolkit for Layer's Web API's (https://developer.layer.com/docs)
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
bin
lib/layer
spec
.gitignore
.rspec
.travis.yml
Gemfile
MIGRATING.md
README.md
Rakefile
layer-api.gemspec

README.md

Layer Ruby Gem

Build Status Gem Version

Simple wrapper for Layer's Web API's

If you want to learn more, check out the official documentation.

Migrating from 0.3.x

Version 0.4 is not compatible with older versions. SEE MIGRATING for details on how to migrate your code to the latest version.

Installation

Add this line to your application's Gemfile:

gem 'layer-api'

And then execute:

$ bundle

Or install it yourself as:

$ gem install layer-api

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:

conversation = platform.conversations.find("fb2f3a48-523d-4449-a57f-c6651fc6612c")
#<Layer::Resources::Conversation @attributes={...}>

# Get the stripped uuid for any resource
conversation.uuid
# => "fb2f3a48-523d-4449-a57f-c6651fc6612c"

conversation.url
# => "https://api.layer.com/apps/<APP_ID>/conversations/fb2f3a48-523d-4449-a57f-c6651fc6612c"

# Retrieve all attributes
conversation.attributes
# => {"id" => "fb2f3a48-523d-4449-a57f-c6651fc6612c", "url" => "https://api.layer.com/apps/<APP_ID>/conversations/fb2f3a48-523d-4449-a57f-c6651fc6612c", ...}

Platform

See the Platform API docs for additional info.

Authentication/setup

platform = Layer::Platform::Client.new(api_token: "your_api_token", app_id: "your_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:

platform = Layer::Platform::Client.new
# => #<Layer::Platform::Client @api_token="...", @app_id="...">

Retrieving Conversations

user = platform.users.find("user_id")
convs = user.conversations.list
# => [#<Layer::Resources::Conversation>, #<Layer::Resources::Conversation>, ...]

Retrieving A Single Conversation

# For a user
user = platform.users.find("user_id")
conv = user.conversations.find("conversation_id")
# => #<Layer::Resources::Conversation @attributes={...}>

# or alternatively
conv = platform.conversations.find("conversation_id")
# => #<Layer::Resources::Conversation @attributes={...}>

Creating Conversations

conversation = {
  participants: [
    "1234",
    "5678"
  ],
  distinct: false,
  metadata: {
    background_color: "#3c3c3c"
  }
}

platform.conversations.create(conversation)
# => #<Layer::Resources::Conversation @attributes={...}>

Editing Conversations

conv = platform.conversations.find("conversation_id")

operations = [
  { operation: "add", property: "participants", value: "user1" },
  { operation: "add", property: "participants", value: "user2" }
]

conv.update(operations)
# => true

Deleting Conversations

conv = platform.conversations.find("conversation_id")
conv.destroy
# => true

Initiating a Rich Content Upload

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

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

message = {
  sender: {
    name: "t-bone"
  },
  parts: [
    {
        body: "Hello, World!",
        mime_type: "text/plain"
    },
    {
        body: "YW55IGNhcm5hbCBwbGVhc3VyZQ==",
        mime_type: "image/jpeg",
        encoding: "base64"
    }
  ],
  notification: {
    text: "This is the alert text to include with the Push Notification.",
    sound: "chime.aiff"
  }
}

conv = platform.conversations.find("conversation_id")
conv.messages.create(message)
# => #<Layer::Resources::Message @attributes={...}>

Retrieving Messages

# From a specific user's perspective
conv = platform.users.find("user_id").conversations.find("conversation_id")
conv.messages.list
# => [#<Layer::Resources::Message>, #<Layer::Resources::Message>, ...]

# From the system's perspective
conv = platform.conversations.find("conversation_id")
conv.messages.list
# => [#<Layer::Resources::Message>, #<Layer::Resources::Message>, ...]

Retrieving A Single Message

# From a specific user's perspective
user = platform.users.find("user_id")
messages = user.messages.find("message_id")
# => #<Layer::Resources::Message @attributes={...}>

# From the systems perspective
conv = platform.conversations.find("conversation_id")
messages = conv.messages.find("message_id")
# => #<Layer::Resources::Message @attributes={...}>

Deleting A Message

conv = platform.conversations.find("conversation_id")
conv.messages.find("message_id").destroy
# => true

Sending Announcements

announcement = {
  recipients: [ "1234", "5678" ],
  sender: {
    name: "The System"
  },
  parts: [
    {
        body: "Hello, World!",
        mime_type: "text/plain"
    }
  ],
  notification: {
    text: "This is the alert text to include with the Push Notification.",
    sound: "chime.aiff"
  }
}

platform.announcements.create(announcement)
# => #<Layer::Resources::Announcement @attributes={...}>

Modifying A Users Block List

user = platform.users.find("user_id")

operations = [
    { operation: "add", property: "blocks", value: "blockMe1" },
    { operation: "add", property: "blocks", value: "blockMe2" },
    { operation: "remove", property: "blocks", value: "unblockMe" }
]

user.update(operations)
# => true

Retrieving A Users Block List

user = platform.users.find("user_id")

blocks = user.blocks.list
# => [#<Layer::Resources::Block>, [#<Layer::Resources::Block>, ...]

Blocking Users

# using params
owner = platform.users.find("owner")
owner.blocks.create(user_id: "blocked")
# => #<Layer::Resources::Block @attributes={...}>

# passing a User object
owner = platform.users.find("owner")
blocked = platform.users.find("blocked")

owner.blocks.create(blocked)
# => #<Layer::Resources::Block @attributes={...}>

Unblocking Users

# using the blocked users id
owner = platform.users.find("owner")
owner.blocks.find("blocked_user").destroy
# => true

# using a User object
owner = platform.users.find("owner")
blocked = platform.users.find("blocked")

owner.blocks.find(blocked).destroy
# => true

Creating a User Identity

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

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

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

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

user = platform.users.find("user_id")
user.destroy_identity
# => true

Setting a Users Badge

user = platform.users.find("user_id")
user.set_badge(10)
# => true

Retrieving a Users Badge

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

Make sure the following environment variables are set: ENV['LAYER_KEY_ID'] ENV['LAYER_PROVIDER_ID'] ENV['LAYER_PRIVATE_KEY']

# Returns a valid signed identity token. #
token = platform.generate_identity_token(user_id: "1234", nonce: "your_random_nonce")
# => #<Layer::IdentityToken:0x007f89b4adb890>

token.to_s
# => "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsInR.cCI6IkpXVCIsImN0eSI6ImxheWVyLWVpdDt2PTEiLCJraWQiOiJhNz.5YTE0MC02YzY3LTExZTUtYjM0Mi1jZGJmNDAwZTE5NDgifQ"

Webhooks

See the Webhooks API docs for additional info.

Authentication/setup

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:

client = Layer::Webhooks::Client.new
# => #<Layer::Webhooks::Client @api_token="...", @app_id="...">

Registering Webhooks

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

client.webhooks.list
# => [#<Layer::Resources::Webhook>, #<Layer::Resources::Webhook>, ...]

Retrieving Webhooks

client.webhooks.find("webhook_id")
# => #<Layer::Resources::Webhook @attributes={...}>

Activating Webhooks

webhook = client.webhooks.find("webhook_id")
webhook.activate

Deactivating Webhooks

webhook = client.webhooks.find("webhook_id")
webhook.deactivate

Deleting Webhooks

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.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/cakejelly/layer-api.