unloq 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 94a280dda4b4c3f7cacaa84a69ac967338e71c46
+  data.tar.gz: 0a4eb6f0d22a3a0572d5a12ae21ee82203990548
+SHA512:
+  metadata.gz: 59ca0165dd20edcddf0fcfbca4906e3289df3d8fa7cae99974f42ec61ed957a67f92f391aa44212dd6d40467704275e0253a5de97341e5a5a9b9060d2ec2f089
+  data.tar.gz: 265f1581b9ca612941d84834a6fae99796096e6d5a842ff14ab97fcfce7a0e387b0921aa46b8e63b508b69780be11b3ebe76f2fcdcbf944bdffd4ccba991e766

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 mattmueller
+
+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,42 @@
+unloq
+=====
+
+Ruby wrapper for the Unloq API.
+
+Both this library as well as portions of the Unloq API are in active development, please keep this in mind when implementing.
+
+## Installation
+
+    gem install unloq
+
+Or add it to your Gemfile
+
+    gem 'unloq'
+
+## Usage
+
+### Instantiate an instance of Unloq::Client
+
+This can be used for all requests within the scope of a given `api_key` and `namespace` - it should not need to be instantiated each time you make an API call.
+
+```ruby
+client = Unloq::Client.new(api_key: 'your-api-key', namespace: 'foo-dev')
+```
+
+
+### Events
+
+Create an event:
+
+```ruby
+author    = Unloq::Author.new(id: 12, type: 'User')
+recipient = Unloq::Recipient.new(id: 13, type: 'User')
+
+client.create_event(author, 'followed', recipient)
+```
+
+
+## Documentation
+
+See [the documentation](http://rubydoc.info/gems/unloq/frames)
+

data/lib/unloq.rb

@@ -0,0 +1,12 @@
+#External libs
+require 'faraday'
+require 'faraday_middleware'
+
+#Unloq Classes
+require 'unloq/version'
+require 'unloq/api_error'
+require 'unloq/entity'
+require 'unloq/entities/author'
+require 'unloq/entities/recipient'
+require 'unloq/events'
+require 'unloq/client'

data/lib/unloq/api_error.rb

@@ -0,0 +1,17 @@
+module Unloq
+  class APIError < StandardError
+
+    attr_reader :status, :body
+
+    def initialize(status, body)
+      @status = status
+      @body   = body
+      super(message)
+    end
+
+    def message
+      "status_code:#{status} body:#{body.inspect}"
+    end
+
+  end
+end

data/lib/unloq/client.rb

@@ -0,0 +1,80 @@
+module Unloq
+  class Client
+
+    include Events
+
+    attr_reader :api_key, :namespace
+
+    # Initialize the client class that will be used for all Unloq interactions.
+    #
+    # @param [String] api_key Your Unloq api key.
+    # @param [String] namespace The namespace under which Unloq events should be created, e.g. appname-dev
+
+    def initialize api_key: nil, namespace: nil
+      unless api_key && namespace
+        raise ArgumentError.new("You must include both an api_key and namespace, e.g. Unloq::Client.new(api_key: 'foo', namespace: 'bar')")
+      end
+
+      @api_key   = api_key
+      @namespace = namespace
+    end
+
+    # Make a post request to the Unloq API
+    #
+    # @param [String] endpoint The resource endpoint, e.g. /events
+    # @param [Hash] body The body payload that should be POSTed
+
+    def post endpoint, body = {}
+      body.merge!(api_key: api_key, namespace: namespace)
+
+      response = connection.post do |req|
+        req.url endpoint
+        req.body = body.to_json
+      end
+
+      format_response_or_raise_error(response)
+    end
+
+
+    # Validate that any author used is of the appropriate type
+    def validate_author author
+      raise ArgumentError.new("Author must be an Unloq::Author or Unloq::Recipient") unless author.is_a?(Unloq::Entity)
+    end
+
+    #Validate that any recipient used is of the appropriate type
+    def validate_recipient recipient
+      raise ArgumentError.new("Recipient must be an Unloq::Author or Unloq::Recipient") unless recipient.is_a?(Unloq::Entity)
+    end
+
+    private
+
+    # Return either the response body or raise a helpful error
+
+    def format_response_or_raise_error response
+      if response.status / 100 == 2
+        response.body
+      else
+        raise Unloq::APIError.new(response.status, response.body)
+      end
+    end
+
+    # Set up basics of all HTTP connections for Unloq api requests
+
+    def connection
+      @connection ||= Faraday.new(url: 'http://api.unloq.co', headers: default_headers) do |conn|
+        conn.request :json
+        conn.adapter Faraday.default_adapter
+        conn.response :json, :content_type => /\bjson$/
+      end
+    end
+
+    # Set default headers for all requests
+
+    def default_headers
+      {
+        user_agent: "Unloq ruby gem #{Unloq::VERSION}"
+      }
+    end
+
+  end
+end

data/lib/unloq/entities/author.rb

@@ -0,0 +1,5 @@
+module Unloq
+  class Author < Unloq::Entity
+
+  end
+end

data/lib/unloq/entities/recipient.rb

@@ -0,0 +1,5 @@
+module Unloq
+  class Recipient < Unloq::Entity
+
+  end
+end

data/lib/unloq/entity.rb

@@ -0,0 +1,15 @@
+module Unloq
+  class Entity
+    attr_reader :id, :type, :meta
+
+    def initialize id: nil, type: nil, meta: {}
+      unless id && type
+        raise ArgumentError.new("You must include both an id and a type, e.g. #{self.class.to_s}.new(id: 1, type: 'User')")
+      end
+
+      @id   = id
+      @type = type
+      @meta = meta
+    end
+  end
+end

data/lib/unloq/events.rb

@@ -0,0 +1,28 @@
+module Unloq
+  module Events
+
+    # Create an event via the Unloq API
+    #
+    # @param [Unloq::Entity] author Author involved in the event
+    # @param [String] verb The verb of the event
+    # @param [Unloq::Entity] recipient Recipient involved in the event
+    # @param [Hash] meta A hash of additional metadata to send with the request
+
+    def create_event author, verb, recipient, meta = {}
+      validate_author(author)
+      validate_recipient(recipient)
+     
+      body_to_post = {
+        author_id: author.id,
+        author_type: author.type,
+        recipient_id: recipient.id,
+        recipient_type: recipient.type,
+        verb: verb,
+        meta: meta
+      }
+     
+      post('/events', body_to_post)
+    end
+
+  end
+end

data/lib/unloq/version.rb

@@ -0,0 +1,3 @@
+module Unloq
+  VERSION = '0.0.2'
+end

metadata

@@ -0,0 +1,167 @@
+--- !ruby/object:Gem::Specification
+name: unloq
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Matt Mueller
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.3'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.9'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.18'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.18'
+description: Ruby gem for interacting with the Unloq API.  See http://www.unloq.co/api_docs/index
+  for more information.
+email: muellermr@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE
+- README.md
+- lib/unloq.rb
+- lib/unloq/api_error.rb
+- lib/unloq/client.rb
+- lib/unloq/entities/author.rb
+- lib/unloq/entities/recipient.rb
+- lib/unloq/entity.rb
+- lib/unloq/events.rb
+- lib/unloq/version.rb
+homepage: http://github.com/mattmueller/unloq
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Ruby gem for interacting with the Unloq API.
+test_files: []