ruby-montage 0.4.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6cd914f1ed0f45c379b03e7d74c6730202efcfd6
+  data.tar.gz: 33cedf4412dd2baee765919a1971d6be3c776af0
+SHA512:
+  metadata.gz: 0fd3016e5a69c1b39cf5097b7cea6088fdc40350e6340095db359de273a63dd8e418b746825191fc0538fb0b00ca1ad6753e8fbd2e325c11b5ff7cbc6d710a4b
+  data.tar.gz: f0a366156d9011c20fc000fce2c02a6401c84b040a8189e04560772192a1b39ab310beaf0a89e64f6869a2832eebfcc836e198a41500a75994423b52298f832c

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.idea
+.env
+tmp.json
+ruby-montage-*.gem

data/.ruby-version

@@ -0,0 +1 @@
+2.2.0

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, 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,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ruby-montage.gemspec
+gemspec
+
+gem "pry"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 dphaener
+
+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,132 @@
+[![Code Climate](https://codeclimate.com/github/EditLLC/ruby-montage/badges/gpa.svg)](https://codeclimate.com/github/EditLLC/ruby-montage)
+[![Circle CI](https://circleci.com/gh/EditLLC/ruby-montage/tree/master.svg?style=svg)](https://circleci.com/gh/EditLLC/ruby-montage/tree/master)
+[![codecov.io](http://codecov.io/github/EditLLC/ruby-montage/coverage.svg?branch=master)](http://codecov.io/github/EditLLC/ruby-montage?branch=master)
+
+# Ruby Montage
+
+A Ruby wrapper for the [Montage](https://www.foo.com) API
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ruby-montage', require: 'montage'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ruby-montage
+
+## Usage
+
+In order to use the API, you will first have to retrieve an authorization token
+
+```ruby
+client = Montage::Client.new do |c|
+  c.username = "YOUR_USERNAME"
+  c.password = "YOUR_PASSWORD"
+  c.api_version # Optional, defaults to 1
+  c.domain = "test" # Your Montage subdomain
+end
+
+response = client.auth
+token = response.token.value
+```
+
+This token does not expire, so it is recommended that you store this token somewhere in your database to avoid having to
+make an API call to retrieve it on every request.
+
+After retrieving a token, you can simply use the client to perform API requests:
+
+```ruby
+client.schemas
+```
+
+Or, use the same token later to initialize a new instance of the client:
+
+```ruby
+client = Montage::Client.new do |c|
+  c.token = "YOUR_TOKEN"
+  c.domain = "test" # Your Montage subdomain
+end
+```
+
+All API actions are available as methods on the client object. The following methods are available:
+
+## Schemas
+
+| Action                          | Method                                              |
+| :------------------------------ | :-------------------------------------------------- |
+| Get a list of schemas           | `#schemas`                                          |
+| Fetch a single schema           | `#schema(name)`                                    |
+
+## Documents
+
+| Action                              | Method                                              |
+| :------------------------------     | :-------------------------------------------------- |
+| Query documents in a schema         | `#documents(schema, query: query)`                  |
+| Fetch a single document             | `#document(schema, document_uuid)`                  |
+| Fetch the next set of documents     | `#document_cursor(schema, cursor)`                  |
+| Delete a document                   | `#delete_document(schema, document_uuid)`           |
+| Create or update a set of documents | `#create_or_update_documents(schema,documents)`     |
+
+
+## Operators
+
+| Operator    | Montage Equivalent |
+| :-----------| :---------         |
+| !=          | __not              |
+| >=          | __gte              |
+| <=          | __lte              |
+| =           |                    |
+| >           | __gt               |
+| <           | __lt               |
+| not in      | __notin            |
+| in          | __in               |
+| not in      | __notin            |
+| like        | __contains         |
+| ilike       | __icontains        |
+
+
+## The Query Object
+
+The Montage API requires a JSON serialized query object to query a schema
+
+    {
+      "limit": 10,
+      "offset": 10,
+      "order_by": "foo",
+      "ordering": "asc",
+      "filter": {
+        ...
+      }
+    }
+
+The Ruby Montage API wrapper provides a query object that has a DSL similar to that of a Rails ActiveRecord object:
+
+```ruby
+query = Montage::Query.new
+query = query.where("foo > 5").limit(10).order(foo: :asc)
+```
+
+This query object can now be passed into an API call to documents to retrieve a set of documents:
+
+```ruby
+c.documents("movies", query)
+```
+
+Using this query object is not required in order to complete a request. Any object that responds to `.to_json` and
+returns an object that conforms to the above query standards will work. This is merely provided as a convenience.
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/ruby-montage/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,12 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.libs << "lib"
+  t.pattern = "test/**/*_test.rb"
+  t.verbose = true
+end
+
+desc "Run tests"
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "montage"
+
+# 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/circle.yml

@@ -0,0 +1,13 @@
+dependencies:
+  override:
+    - 'rvm-exec 1.9.3-p551 bundle install'
+    - 'rvm-exec 2.0.0-p598 bundle install'
+    - 'rvm-exec 2.1.5 bundle install'
+    - 'rvm-exec 2.2.0 bundle install'
+
+test:
+  override:
+    - 'CI=true rvm-exec 1.9.3-p551 bundle exec rake'
+    - 'CI=true rvm-exec 2.0.0-p598 bundle exec rake'
+    - 'CI=true rvm-exec 2.1.5 bundle exec rake'
+    - 'CI=true rvm-exec 2.2.0 bundle exec rake'

data/lib/montage.rb

@@ -0,0 +1,6 @@
+require 'montage/version'
+require 'montage/client'
+require 'montage/query'
+
+module Montage
+end

data/lib/montage/client.rb

@@ -0,0 +1,109 @@
+require 'montage/response'
+require 'faraday'
+require 'faraday_middleware'
+require 'json'
+require 'montage/client/files'
+require 'montage/client/schemas'
+require 'montage/client/documents'
+require 'montage/errors'
+
+module Montage
+  class Client
+    include Files
+    include Schemas
+    include Documents
+
+    attr_accessor :token, :username, :password, :domain, :api_version
+
+    def initialize
+      @api_version = 1
+      yield(self) if block_given?
+      raise MissingAttributeError, "You must declare the domain attribute" unless @domain
+    end
+
+    def content_type
+      "application/json"
+    end
+
+    def auth
+      build_response("token") do
+        connection.post do |req|
+          req.headers.delete("Authorization")
+          req.url "auth/"
+          req.body = { username: username, password: password }.to_json
+        end
+      end
+    end
+
+    def get(url, resource_name, options = {})
+      build_response(resource_name) do
+        connection.get do |req|
+          req.url url
+          req.params = options
+        end
+      end
+    end
+
+    def post(url, resource_name, options = {})
+      build_response(resource_name) do
+        connection.post do |req|
+          req.url url
+          req.body = options.to_json
+        end
+      end
+    end
+
+    def put(url, resource_name, options = {})
+      build_response(resource_name) do
+        connection.put do |req|
+          req.url url
+          req.body = options.to_json
+        end
+      end
+    end
+
+    def delete(url, resource_name, options = {})
+      build_response(resource_name) do
+        connection.delete do |req|
+          req.url url
+          req.body = options.to_json
+        end
+      end
+    end
+
+    def set_token(token)
+      @token = token
+      connection.headers["Authorization"] = "Token #{token}"
+    end
+
+    def response_successful?(response)
+      return false if response.body["errors"]
+      response.success?
+    end
+
+    def build_response(resource_name, &block)
+      response = yield
+      resource = response_successful?(response) ? resource_name : "error"
+
+      response_object = Montage::Response.new(response.status, response.body, resource)
+
+      if resource_name == "token" && response.success?
+        set_token(response_object.token.value)
+      end
+
+      response_object
+    end
+
+    def connection
+      @connect ||= Faraday.new do |f|
+        f.adapter :net_http
+        f.url_prefix = "http://#{domain}.dev.montagehot.club/api/v#{api_version}/"
+        f.headers["User-Agent"] = "Montage Ruby v#{Montage::VERSION}"
+        f.headers["Content-Type"] = content_type
+        f.headers["Accept"] = "*/*"
+        f.headers["Authorization"] = "Token #{token}"
+        f.response :json, content_type: /\bjson$/
+      end
+    end
+  end
+end

data/lib/montage/client/documents.rb

@@ -0,0 +1,79 @@
+module Montage
+  class Client
+    module Documents
+      # Public: Get a list of documents
+      #
+      # Params:
+      #   schema - *Required* The name of the schema to run the query against
+      #   query  - *Optional* A Montage::Query object to pass along with the request
+      #
+      # Returns a Montage::Response
+      #
+      def documents(schema, query = {})
+        post("schemas/#{schema}/query/", "document", query)
+      end
+
+      # Public: Fetch a document
+      #
+      # Params:
+      #   schema        - *Required* The name of the schema to fetch the document from
+      #   document_uuid - *Required* The uuid of the document to fetch
+      #
+      # Returns a Montage::Response
+      #
+      def document(schema, document_uuid)
+        get("schemas/#{schema}/#{document_uuid}/", "document")
+      end
+
+      # Public: Get the set of documents for the given cursor
+      #
+      # Params:
+      #   schema - *Required* The name of the schema to run the query against
+      #   cursor - *Required* The cursor that was returned in the last document API call
+      #
+      # Returns a Montage::Response
+      #
+      # def document_cursor(schema, cursor)
+        # get("schemas/#{schema}/?cursor=#{cursor}", "document")
+      # end
+
+      # Public: Create or update a set of documents
+      #
+      # Params:
+      #   schema   - *Required* The name of the schema to add the document to
+      #   document - *Required* The Hash representation of the document you would like to create
+      #
+      # The document must conform to the schema definition
+      #
+      # Returns a Montage::Response
+      def create_or_update_documents(schema, documents)
+        post("schemas/#{schema}/save/", "document", documents)
+      end
+
+      # Public: Update a document
+      #
+      # Params:
+      #   schema        - *Required* The name of the schema the document belongs to
+      #   document_uuid - *Required* The uuid of the document you wish to update
+      #   document      - *Required* The Hash representation of the document you would like to update
+      #
+      # The document must conform to the schema definition
+      #
+      # Returns a Montage::Response
+      def update_document(schema, document)
+        post("schemas/#{schema}/save/", "document", document)
+      end
+
+      # Public: Delete a document
+      #
+      # Params:
+      #   schema        - *Required* The name of the schema the document belongs to
+      #   document_uuid - *Required* The uuid of the document you widh to delete
+      #
+      # Returns a Montage::Response
+      def delete_document(schema, document_uuid)
+        delete("schemas/#{schema}/#{document_uuid}/", "document")
+      end
+    end
+  end
+end