layer-ruby 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0b96d42aefcf7cdc0a293085a3d93d678c62663d
+  data.tar.gz: cde6707f405032ad6f696c9c7a7d8ffea647cafc
+SHA512:
+  metadata.gz: 60090694dd66693d41775605a1d17f160b8372e47e9b55350b03ac0bc3a8080b9fcc45d9180eb8a09c24b34978d54e519a4c170d79eed2684a9b863d9d3fbaca
+  data.tar.gz: 7b0e2b54c9540030562c1ac029aedee2a63a89d6bfcf1024830f25cc34c3740f718a66290337bf89cdf917caec4f45da06cab386aa5a3722345cf052643bb46e

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.2.0
+before_install: gem install bundler -v 1.10.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,16 @@
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # Feel free to open issues for suggestions and improvements
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Benedikt Deicke
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,90 @@
+# Layer Platform API
+
+[![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). 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'layer-ruby', require: 'layer'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install layer-ruby
+
+## Usage
+
+Please refer to the [Layer Platform API documentation](https://developer.layer.com/docs/platform) for details about the required payloads and responses. 
+
+### Configuration
+
+To use interact with the Layer Platform API, you need your Layer APP ID as well as a Layer Platform API Token. The gem reads both values from the `LAYER_APP_ID` and `LAYER_PLATFORM_TOKEN` environment variables. Alternatively you can specify the values by configuring the `Layer::Client` like this:
+
+```ruby
+Layer::Client.configure do |config|
+  config.app_id = 'YOUR_APP_ID_HERE'
+  config.token = 'YOUR_PLATFORM_TOKEN_HERE'
+end
+```
+
+### Creating Conversations
+
+```ruby
+conversation = Layer::Conversation.create({ participants: ['1', '2'] })
+```
+
+### Retrieving Conversations
+
+To retrieve a existing conversation, just use `Conversation.find` passing it the conversation id:
+
+```ruby
+conversation = Layer::Conversation.find('CONVERSATION_ID_HERE')
+```
+
+### 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' }])
+```
+
+### Using the gem with multiple applications at once
+
+It's possible to create a new instance of `Layer::Client` and passing both the app id and the token to the initializer:
+
+```ruby
+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. 
+
+## 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/benedikt/layer-ruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+## Related Work
+
+Check out the [layer-identity_token](https://github.com/dreimannzelt/layer-identity_token) gem to generate authentication tokens for the Layer SDK. 
+

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/ruby"
+
+# 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-ruby.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'layer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "layer-ruby"
+  spec.version       = Layer::VERSION
+  spec.authors       = ["Benedikt Deicke"]
+  spec.email         = ["benedikt@benediktdeicke.com"]
+
+  spec.summary       = %q{Ruby bindings for the Layer Platform API}
+  spec.description   = %q{Ruby bindings for the Layer Platform API}
+  spec.homepage      = "https://github.com/benedikt/layer-ruby"
+  spec.license       = "MIT"
+
+  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_dependency "rest-client", "~> 1.8"
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "guard-rspec"
+end

data/lib/layer.rb

@@ -0,0 +1,10 @@
+require 'layer/version'
+require 'layer/client'
+require 'layer/operations'
+require 'layer/resource'
+require 'layer/relation_proxy'
+require 'layer/conversation'
+require 'layer/message'
+
+module Layer
+end

data/lib/layer/client.rb

@@ -0,0 +1,74 @@
+require 'rest-client'
+
+module Layer
+  class Client
+    class << self
+      attr_writer :app_id, :token
+
+      def app_id
+        @app_id || ENV['LAYER_APP_ID']
+      end
+
+      def token
+        @token ||= ENV['LAYER_PLATFORM_TOKEN']
+      end
+
+      def configure
+        yield self
+      end
+    end
+
+    attr_reader :app_id, :token
+
+    def initialize(app_id = self.class.app_id, token = self.class.token)
+      @app_id = app_id
+      @token = token
+    end
+
+    def get(*args)
+      request(:get, *args)
+    end
+
+    def post(*args)
+      request(:post, *args)
+    end
+
+    def patch(*args)
+      request(:patch, *args)
+    end
+
+    def put(*args)
+      request(:put, *args)
+    end
+
+    def delete(*args)
+      request(:delete, *args)
+    end
+
+    def head(*args)
+      request(:head, *args)
+    end
+
+    def options(*args)
+      request(:options, *args)
+    end
+
+  private
+
+    def request(method, url, payload = {}, headers = {})
+      url = "https://api.layer.com/apps/#{app_id}#{url}" unless url.start_with?('https://api.layer.com')
+
+      headers = {
+        'Authorization' => "Bearer #{token}",
+        'Accept' => 'application/vnd.layer+json; version=1.0',
+        'Content-Type' => 'application/json'
+      }.merge(headers)
+
+      payload = payload.to_json
+
+      response = RestClient::Request.execute(method: method, url: url, payload: payload, headers: headers)
+      JSON.parse(response)
+    end
+
+  end
+end

data/lib/layer/conversation.rb

@@ -0,0 +1,19 @@
+module Layer
+  class Conversation < Resource
+    include Operations::Find
+    include Operations::Create
+
+    def messages
+      RelationProxy.new(self, Message, [Operations::Create])
+    end
+
+    def distinct?
+      attributes['distinct']
+    end
+
+    def created_at
+      Time.parse(attributes['created_at'])
+    end
+
+  end
+end

data/lib/layer/message.rb

@@ -0,0 +1,13 @@
+module Layer
+  class Message < Resource
+
+    def conversation
+      Conversation.from_response(attributes['conversation'], client)
+    end
+
+    def sent_at
+      Time.parse(attributes['sent_at'])
+    end
+
+  end
+end

data/lib/layer/operations.rb

@@ -0,0 +1,2 @@
+require 'layer/operations/create'
+require 'layer/operations/find'

data/lib/layer/operations/create.rb

@@ -0,0 +1,18 @@
+module Layer
+  module Operations
+    module Create
+
+      module ClassMethods
+        def create(attributes = {}, client = Client.new)
+          response = client.post(url, attributes)
+          from_response(response, client)
+        end
+      end
+
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+
+    end
+  end
+end

data/lib/layer/operations/find.rb

@@ -0,0 +1,19 @@
+module Layer
+  module Operations
+    module Find
+
+      module ClassMethods
+        def find(id, client = Client.new)
+          response = client.get("#{url}/#{id}")
+          from_response(response, client)
+        end
+      end
+
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+
+    end
+  end
+end
+

data/lib/layer/relation_proxy.rb

@@ -0,0 +1,32 @@
+module Layer
+  class RelationProxy
+
+    attr_reader :resource_type, :base
+
+    def initialize(base, resource_type, operations = [])
+      @resource_type = resource_type
+      @base = base
+
+      operations.each { |operation| singleton_class.include(operation::ClassMethods) }
+    end
+
+    def url
+      "#{base.url}#{resource_type.url}"
+    end
+
+    def respond_to_missing?(method, include_private = false)
+      resource_type.respond_to?(method, include_private) || super
+    end
+
+  private
+
+    def method_missing(method, *args, &block)
+      if resource_type.respond_to?(method)
+        resource_type.public_send(method, *args, &block)
+      else
+        super
+      end
+    end
+
+  end
+end

data/lib/layer/resource.rb

@@ -0,0 +1,48 @@
+module Layer
+  class Resource
+
+    class << self
+      def class_name
+        name.split('::')[-1]
+      end
+
+      def url
+        "/#{class_name.downcase.to_s}s"
+      end
+
+      def from_response(attributes, client)
+        new(attributes, client)
+      end
+    end
+
+    def initialize(attributes = {}, client = Client.new)
+      @attributes = attributes
+      @client = client
+    end
+
+    def url
+      attributes['url']
+    end
+
+    def id
+      attributes['id']
+    end
+
+    def respond_to_missing?(method, include_private = false)
+      attributes.has_key?(method.to_s) || super
+    end
+
+  private
+
+    attr_reader :attributes, :client
+
+    def method_missing(method, *args, &block)
+      if attributes.has_key?(method.to_s)
+        attributes[method.to_s]
+      else
+        super
+      end
+    end
+
+  end
+end

data/lib/layer/ruby.rb

@@ -0,0 +1 @@
+require 'layer'

data/lib/layer/version.rb

@@ -0,0 +1,3 @@
+module Layer
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification
+name: layer-ruby
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Benedikt Deicke
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-06-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ruby bindings for the Layer Platform API
+email:
+- benedikt@benediktdeicke.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- layer-ruby.gemspec
+- lib/layer.rb
+- lib/layer/client.rb
+- lib/layer/conversation.rb
+- lib/layer/message.rb
+- lib/layer/operations.rb
+- lib/layer/operations/create.rb
+- lib/layer/operations/find.rb
+- lib/layer/relation_proxy.rb
+- lib/layer/resource.rb
+- lib/layer/ruby.rb
+- lib/layer/version.rb
+homepage: https://github.com/benedikt/layer-ruby
+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.5
+signing_key: 
+specification_version: 4
+summary: Ruby bindings for the Layer Platform API
+test_files: []
+has_rdoc: