kinto_box 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a55dde94245bcbc28a2a18b78ce2cbfaedf0c048
+  data.tar.gz: f213d31d114f44e1fe0d7060af203d6898c60c85
+SHA512:
+  metadata.gz: 3d65b397f340e00cfcd78ab3b7fdabaab1594092a9ac93a61b607ea9e75e5ed9569e5b062a3f77b9edb23c129ae271ca4ed73bd0d1cd6167efd5ec3d8e5d6218
+  data.tar.gz: dfcfae59220e9f8a82947cad3632949a19112c99e4905b24e2f56c4d554896ff1f4427289f6bce72e949113a7fcb650713a2b69f6833fc944a5d539867cd00a2

data/.gitignore

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

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Kavya Sukumar
+
+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,39 @@
+# Kinto Box [![Gem Version](https://badge.fury.io/rb/kinto_box.svg)](https://badge.fury.io/rb/kinto_box)
+
+Kinto Box is a ruby client for [Kinto](http://kinto.readthedocs.io)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'kinto_box'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install kinto_box
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bundle install` to install dependencies. Then, run `bundle exec rake test` to run the tests.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/kavyasukumar/kinto_box.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "kinto_box"
+
+# 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,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/kinto_box.gemspec

@@ -0,0 +1,36 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'kinto_box/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "kinto_box"
+  spec.version       = KintoBox::VERSION
+  spec.authors       = ["Kavya Sukumar"]
+  spec.email         = ["Kavya.Sukumar@voxmedia.com"]
+
+  spec.summary       = %q{Kinto http client in ruby}
+  spec.description   = %q{Kinto http client in ruby}
+  spec.homepage      = "http://github.com/kavyasukumar/kinto_box"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  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_runtime_dependency 'httparty', '~> 0.13.7'
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency 'json', '~> 1.8', '>= 1.8.3'
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

data/lib/kinto_box/kinto_box.rb

@@ -0,0 +1,72 @@
+require "kinto_box/version"
+require 'httparty'
+require 'kinto_box/response_handler'
+require 'kinto_box/kinto_bucket'
+require 'base64'
+
+module KintoBox
+  class KintoClient
+    include HTTParty
+    headers 'Accept' => 'application/json', 'Content-Type' => 'application/json'
+    format :json
+
+    def initialize(server, options = nil)
+      @server = server
+      self.class.base_uri URI.join(@server, '/v1/').to_s
+
+      unless options.nil? || options[:username].nil? || options[:password].nil?
+        @auth = Base64.encode64("#{options[:username]}:#{options[:password]}")
+      end
+
+      @auth = ENV['KINTO_API_TOKEN'] if @auth.nil?
+      self.class.headers('Authorization' => "Basic #{@auth}")
+    end
+
+    def bucket (bucket_id)
+      @bucket = KintoBucket.new(self, bucket_id)
+      @bucket
+    end
+
+    def server_info
+      get '/'
+    end
+
+    def current_user_id
+      server_info['user']['id']
+    end
+
+    # buckets
+    def list_buckets
+      get '/buckets'
+    end
+
+    def create_bucket(bucket_id)
+      put "/buckets/#{bucket_id}"
+      bucket(bucket_id)
+    end
+
+    def delete_buckets
+      delete '/buckets'
+    end
+
+    def put(path, data = {})
+      ResponseHandler.handle self.class.put(path, :body => data.to_json)
+    end
+
+    def post(path, data = {})
+      ResponseHandler.handle self.class.post(path, :body => data.to_json)
+    end
+
+    def patch(path, data)
+      ResponseHandler.handle self.class.patch(path, :body => data.to_json)
+    end
+
+    def delete(path)
+      ResponseHandler.handle self.class.delete(path)
+    end
+
+    def get(path)
+      ResponseHandler.handle self.class.get(path)
+    end
+  end
+end

data/lib/kinto_box/kinto_bucket.rb

@@ -0,0 +1,28 @@
+require 'kinto_box/kinto_collection'
+require 'kinto_box/kinto_object'
+module KintoBox
+  class KintoBucket
+    include KintoObject
+
+    attr_accessor :id
+    attr_reader :kinto_client
+
+    def initialize (client, bucket_id)
+      raise ArgumentError if bucket_id.nil? || client.nil?
+
+      @kinto_client = client
+      @id = bucket_id
+      @url_path = "/buckets/#{@id}"
+    end
+
+    def collection (collection_id)
+      @collection = KintoCollection.new(self, collection_id)
+      @collection
+    end
+
+    def create_collection(collection_id)
+      @kinto_client.post("#{@url_path}/collections", { 'data' => { 'id' => collection_id}})
+      collection(collection_id)
+    end
+  end
+end

data/lib/kinto_box/kinto_collection.rb

@@ -0,0 +1,35 @@
+require 'kinto_box/kinto_record'
+require 'kinto_box/kinto_object'
+require 'kinto_box/kinto_object'
+module KintoBox
+  class KintoCollection
+    include KintoObject
+
+    attr_accessor :id
+    attr_reader :bucket
+
+    def initialize (bucket, collection_id)
+      raise ArgumentError if bucket.nil? || collection_id.nil?
+      @kinto_client = bucket.kinto_client
+      @bucket = bucket
+      @id = collection_id
+      @url_path = "/buckets/#{bucket.id}/collections/#{@id}"
+    end
+
+    def record (record_id, return_ref = false)
+      record = KintoRecord.new(self, record_id)
+      return record if return_ref
+      record.info
+    end
+
+    def list_records
+      @kinto_client.get("#{@url_path}/records")
+    end
+
+    def create_record(data)
+      resp = @kinto_client.post("#{@url_path}/records", { 'data' => data})
+      record_id = resp['data']['id']
+      record(record_id, true)
+    end
+  end
+end

data/lib/kinto_box/kinto_object.rb

@@ -0,0 +1,58 @@
+module KintoBox
+  module KintoObject
+    def info
+      @kinto_client.get(@url_path)
+    end
+
+    def delete
+      @kinto_client.delete(@url_path)
+    end
+
+    def update(data)
+      @kinto_client.patch(@url_path, {'data' => data})
+    end
+
+    def add_permission(principal, permission)
+      @kinto_client.patch(@url_path, {'permissions' => { permission_name(permission) => [principal_name(principal)] }})
+      return self
+    end
+
+    def replace_permission(principal, permission)
+      @kinto_client.put(@url_path, {'permissions' => { permission_name(permission) => [principal_name(principal)] }})
+      return self
+    end
+
+    def permissions
+      info['permissions']
+    end
+
+    private
+
+    def permission_name(permission)
+      case permission.downcase
+        when 'read'
+          return 'read'
+        when 'write'
+          return 'write'
+        when 'create'
+          return 'collection:create' if self.kind_of? KintoBucket
+          return 'record:create' if self.kind_of? KintoCollection
+        else
+          raise Exception 'not a valid permission'
+      end
+    end
+
+    def principal_name(principal)
+      case principal.downcase
+        when 'authenticated'
+          return 'system.Authenticated'
+        when 'anonymous'
+          return 'system.Everyone'
+        when 'everyone'
+          return 'system.Everyone'
+        else
+          return principal
+      end
+    end
+  end
+end

data/lib/kinto_box/kinto_record.rb

@@ -0,0 +1,17 @@
+require 'kinto_box/kinto_object'
+module KintoBox
+  class KintoRecord
+    include KintoObject
+    attr_reader :id
+    def initialize (collection, record_id)
+      raise ArgumentError if collection.nil? || record_id.nil?
+      @kinto_client = collection.bucket.kinto_client
+      @id = record_id
+      @url_path = "/buckets/#{collection.bucket.id}/collections/#{collection.id}/records/#{@id}"
+    end
+
+    def replace(data)
+      @kinto_client.put(@url_path, {'data' => data})
+    end
+  end
+end

data/lib/kinto_box/response_handler.rb

@@ -0,0 +1,55 @@
+module KintoBox
+  # Base exception class for all API Client exceptions
+  class Error < StandardError
+    attr_reader :response, :data
+    def initialize(response)
+      @response = response
+      @data ||= begin
+        JSON.parse(response.body)
+      rescue
+        {}
+      end
+
+      super("#{response.code} #{response.request.uri} #{response.body}")
+    end
+  end
+
+  # Raised when there was something wrong with the request
+  class BadRequest < Error; end
+
+  # Raised when the authentication information is incorrect or incomplete
+  class NotAllowed < Error; end
+
+  # Raised when the requested thing is not found
+  class NotFound < Error; end
+
+  # Raised when the user is not authorized
+  class NotAuthorized < Error; end
+
+  # Raised when there is some sort of error on the server
+  class ServerError < Error; end
+
+  class ResponseHandler
+    def self.handle(resp)
+      if [200, 201].include? resp.code
+        JSON.parse resp.body
+      elsif [202, 204].include? resp.code
+        true
+      elsif resp.code == 400
+        raise BadRequest, resp
+      elsif resp.code == 404
+        raise NotFound, resp
+      elsif resp.code == 401
+        raise NotAllowed, resp
+      elsif resp.code == 403
+        raise NotAuthorized, resp
+      elsif resp.code >= 500
+        raise ServerError, resp
+      else
+        raise Error, resp
+      end
+    end
+
+  end
+
+end

data/lib/kinto_box/version.rb

@@ -0,0 +1,3 @@
+module KintoBox
+  VERSION = "0.1.2"
+end

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification
+name: kinto_box
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- Kavya Sukumar
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-06-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.7
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.3
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: Kinto http client in ruby
+email:
+- Kavya.Sukumar@voxmedia.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- kinto_box.gemspec
+- lib/kinto_box/kinto_box.rb
+- lib/kinto_box/kinto_bucket.rb
+- lib/kinto_box/kinto_collection.rb
+- lib/kinto_box/kinto_object.rb
+- lib/kinto_box/kinto_record.rb
+- lib/kinto_box/response_handler.rb
+- lib/kinto_box/version.rb
+homepage: http://github.com/kavyasukumar/kinto_box
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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: Kinto http client in ruby
+test_files: []