layer-api 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8b4456ca45c29a36081fc82245729c848fc6f301
+  data.tar.gz: e28f390d1b9be7eaa4f9d68fafae58ca0a06c646
+SHA512:
+  metadata.gz: 85a250b727905e5d1bcddd805e1ca0a94c0b14782831e8c00c1ec6f7103600439871c2c4739e823148dbe40faeec51732ad9cfd411651f294a23cbaf5e260b64
+  data.tar.gz: 74047150a0f0f44ebbd314a5a672be5fde226bb6ab2d8088277f4645eb2c152941e581a7e003b36942bde77440f84ebecd44a931768452286546e25ea8b743f8

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.1.5
+before_install: gem install bundler -v 1.10.4

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in layer-api.gemspec
+gemspec

data/README.md

@@ -0,0 +1,153 @@
+# Layer::Api
+[![Build Status](https://travis-ci.org/cakejelly/layer-api.svg?branch=master)](https://travis-ci.org/cakejelly/layer-api) [![Gem Version](https://badge.fury.io/rb/layer-api.svg)](http://badge.fury.io/rb/layer-api)
+
+A very simple wrapper for the Layer Platform API.
+
+If you want to learn more, check out the [official documentation](https://developer.layer.com/docs/platform).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'layer-api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install layer-api
+
+## Usage
+
+### Authentication/setup
+
+```ruby
+layer = Layer::Api::Client.new(
+  api_token: "your_api_token",
+  app_id: "your_app_id"
+)
+```
+If you have `ENV['LAYER_API_TOKEN']` and `ENV['LAYER_APP_ID']` environment variables setup, they will be used by default don't need to be included:
+```ruby
+layer = Layer::Api::Client.new
+```
+
+### Retrieving conversations
+
+```ruby
+layer.get_conversation("conversation_id")
+```
+
+### Creating conversations
+
+```ruby
+# A sample conversation
+conversation = {
+  participants: [
+    "1234",
+    "5678"
+  ],
+  distinct: false,
+  metadata: {
+    background_color: "#3c3c3c"
+  }
+}
+
+layer.create_conversation(conversation)
+```
+
+### Editing conversations
+
+```ruby
+# Sample edit operations
+operations = [
+  {operation: "add", property: "participants", value: "user1"},
+  {operation: "add", property: "participants", value: "user2"}
+]
+
+layer.edit_conversation(operations)
+```
+
+### Sending messages
+```ruby
+# A sample message to send
+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"
+  }
+}
+
+layer.send_message("conversation_id", message)
+
+```
+
+### Sending Announcements
+
+```ruby
+# A sample announcement
+announcement = {
+  recipients: [ "1234", "5678" ],
+  sender: {
+    name: "The System"
+  },
+  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"
+  }
+}
+
+layer.send_announcement(announcement)
+```
+
+### Managing User Block Lists
+
+```ruby
+# Retrieves a users blocklist
+layer.get_blocklist("user_id")
+
+# Adds a user to another users blocklist
+layer.block_user("owner_id", "user_id")
+
+# Removes a user from another users blocklist
+layer.unblock_user("owner_id", "user_id")
+```
+
+## 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](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/cakejelly/layer-api.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "layer/api"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/layer-api.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'layer/api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "layer-api"
+  spec.version       = Layer::Api::VERSION
+  spec.authors       = ["Jake Kelly"]
+  spec.email         = ["jake.kelly10@gmail.com"]
+  spec.license       = "MIT"
+
+  spec.summary       = "A ruby toolkit for Layer's Platform API (https://developer.layer.com/docs/platform)"
+  spec.description   = "Simple wrapper for the Layer Platform API"
+  spec.homepage      = "https://github.com/cakejelly/layer-api"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.3", ">= 3.3.0"
+  spec.add_development_dependency "vcr", "~> 2.9", ">= 2.9.3"
+  spec.add_development_dependency "webmock", "~> 1.21", ">= 1.21.0"
+  spec.add_development_dependency "pry", "~> 0.10.1"
+
+  spec.add_dependency "faraday", "~> 0.9.1"
+end

data/lib/layer/api.rb

@@ -0,0 +1,15 @@
+require 'faraday'
+require 'json'
+
+require "layer/api/version"
+require "layer/api/configuration"
+require "layer/api/connection"
+require "layer/api/client"
+require "layer/api/error"
+
+require "layer/api/middleware/api_errors"
+
+module Layer
+  module Api
+  end
+end

data/lib/layer/api/client.rb

@@ -0,0 +1,23 @@
+require "layer/api/client/conversations"
+require "layer/api/client/announcements"
+require "layer/api/client/users"
+
+module Layer
+  module Api
+    class Client
+      include Layer::Api::Connection
+      include Layer::Api::Configuration
+
+      include Layer::Api::Conversations
+      include Layer::Api::Announcements
+      include Layer::Api::Users
+
+      attr_accessor :api_token, :app_id
+
+      def initialize(options = {})
+        @api_token = options[:api_token] || ENV['LAYER_API_TOKEN']
+        @app_id = options[:app_id] || ENV['LAYER_APP_ID']
+      end
+    end
+  end
+end

data/lib/layer/api/client/announcements.rb

@@ -0,0 +1,9 @@
+module Layer
+  module Api
+    module Announcements
+      def send_announcement(announcement = {})
+        post("announcements", body: announcement.to_json)
+      end
+    end
+  end
+end

data/lib/layer/api/client/conversations.rb

@@ -0,0 +1,30 @@
+module Layer
+  module Api
+    module Conversations
+      def get_conversation(conversation_id)
+        get("conversations/#{conversation_id}")
+      end
+
+      def create_conversation(params = {})
+        post("conversations", body: params.to_json)
+      end
+
+      def edit_conversation(conversation_id, params = {})
+        patch("conversations/#{conversation_id}",
+          body: params.to_json,
+          headers: layer_patch_header
+        )
+      end
+
+      def send_message(conversation_id, message = {})
+        post("conversations/#{conversation_id}/messages",
+          body: message.to_json
+        )
+      end
+
+      def get_stripped_id(raw_id)
+        raw_id.sub("layer:///conversations/", "")
+      end
+    end
+  end
+end

data/lib/layer/api/client/users.rb

@@ -0,0 +1,18 @@
+module Layer
+  module Api
+    module Users
+      def get_blocklist(user_id)
+        get("users/#{user_id}/blocks")
+      end
+
+      def block_user(owner_id, user_id)
+        params = { user_id: user_id }
+        post("users/#{owner_id}/blocks", body: params.to_json)
+      end
+
+      def unblock_user(owner_id, user_id)
+        delete("users/#{owner_id}/blocks/#{user_id}")
+      end
+    end
+  end
+end

data/lib/layer/api/configuration.rb

@@ -0,0 +1,23 @@
+module Layer
+  module Api
+    module Configuration
+      DEFAULT_HOST = "https://api.layer.com"
+
+      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
+end

data/lib/layer/api/connection.rb

@@ -0,0 +1,40 @@
+module Layer
+  module Api
+    module Connection
+      def connection
+        connection ||= Faraday.new(url: base_url) do |faraday|
+          faraday.headers = default_layer_headers
+          faraday.request  :url_encoded
+          faraday.adapter  Faraday.default_adapter
+          faraday.use Middleware::ApiErrors
+        end
+      end
+
+      def get(url, options = {})
+        run_request(:get, url, options)
+      end
+
+      def post(url, options = {})
+        run_request(:post, url, options)
+      end
+
+      def patch(url, options = {})
+        run_request(:patch, url, options)
+      end
+
+      def delete(url)
+        run_request(:delete, url, options = {})
+      end
+
+      def run_request(method, url, options = {})
+        response = connection.run_request(
+          method,
+          url,
+          options[:body],
+          options[:headers]
+        )
+        JSON.parse(response.body) if !response.body.empty?
+      end
+    end
+  end
+end

data/lib/layer/api/error.rb

@@ -0,0 +1,36 @@
+module Layer
+  module Api
+    class Error < StandardError
+      def self.from_response(response)
+        status = response[:status]
+
+        if klass =  case status
+                    when 400 then Layer::Api::BadRequest
+                    when 404 then Layer::Api::NotFound
+                    when 500..599 then Layer::Api::ServerError
+                    else self
+                    end
+        end
+
+        klass.new(response)
+      end
+
+      def initialize(response)
+        @response = response
+        super(build_error_message)
+      end
+
+      private
+
+      def build_error_message
+        message = "Layer responded with status "
+        message << "#{@response[:status]}: #{@response[:body]}"
+        message
+      end
+    end
+
+    class BadRequest < Error; end
+    class NotFound < Error; end
+    class ServerError < Error; end
+  end
+end

data/lib/layer/api/middleware/api_errors.rb

@@ -0,0 +1,15 @@
+module Layer
+  module Api
+    module Middleware
+      class ApiErrors < Faraday::Response::Middleware
+        ERROR_CODES = 400...600
+
+        def on_complete(response)
+          if ERROR_CODES.include?(response.status)
+            raise Layer::Api::Error.from_response(response)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/layer/api/version.rb

@@ -0,0 +1,5 @@
+module Layer
+  module Api
+    VERSION = "0.1.1"
+  end
+end

metadata

@@ -0,0 +1,180 @@
+--- !ruby/object:Gem::Specification
+name: layer-api
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Jake Kelly
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-07-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.9.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.9.3
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.21.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.21.0
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.1
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+description: Simple wrapper for the Layer Platform API
+email:
+- jake.kelly10@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- layer-api.gemspec
+- lib/layer/api.rb
+- lib/layer/api/client.rb
+- lib/layer/api/client/announcements.rb
+- lib/layer/api/client/conversations.rb
+- lib/layer/api/client/users.rb
+- lib/layer/api/configuration.rb
+- lib/layer/api/connection.rb
+- lib/layer/api/error.rb
+- lib/layer/api/middleware/api_errors.rb
+- lib/layer/api/version.rb
+homepage: https://github.com/cakejelly/layer-api
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.3
+signing_key: 
+specification_version: 4
+summary: A ruby toolkit for Layer's Platform API (https://developer.layer.com/docs/platform)
+test_files: []
+has_rdoc: