elemeno 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ad83aa3e75e469c0e8d27052e844af2cb6899f80
+  data.tar.gz: 815a4ceae23c5cd4eef15348284bead79768c01d
+SHA512:
+  metadata.gz: f8dbd87725382774760f856ea3151f61605e84979c3754e40866e9768e93f990cfbc2586c3415f621a8cadd36ee0b24dc425ebab55e0fcb5cb146619a706ccc1
+  data.tar.gz: 67ac205dbd3e66cca509878331a199d98b2067543b35fb100b31f1b61f826922742bbfd22bca03ead2517c60d95240d728d1609911f24464f9e90bbebf172877

data/.editorconfig

@@ -0,0 +1,16 @@
+# EditorConfig helps developers define and maintain consistent
+# coding styles between different editors and IDEs
+# editorconfig.org
+
+root = true
+
+[*]
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+indent_style = tab
+indent_size = 4
+
+[*.{diff,md}]
+trim_trailing_whitespace = false

data/.gitignore

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

data/Gemfile

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

data/LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Elemeno Technology Inc. (https://elemeno.io)
+
+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,150 @@
+# Elemeno
+
+The official Ruby client for Elemeno, an API based CMS. Use this module to easily integrate your content created on Elemeno into your Ruby projects.
+
+Create an account and get started for free at https://elemeno.io
+
+## Requirements
+
+- A minimum of Ruby 1.9.3
+- [Bundler](http://bundler.io/)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'elemeno'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install elemeno
+
+## Elemeno Documentation
+
+Documentation is available at http://docs.elemeno.io
+
+## Usage
+
+Include the Elemeno module:
+
+```ruby
+require "elemeno"
+```
+
+Create a new instance of the Elemeno Client with an API Key from your project
+
+```ruby
+elemeno = Elemeno::Client.new('123e4567-e89b-12d3-a456-426655440000')
+```
+
+**Note: API keys can be created in your project settings**
+
+## Example Usage
+
+```ruby
+require "elemeno"
+
+elemeno = Elemeno::Client.new('123e4567-e89b-12d3-a456-426655440000')
+
+options = {
+	'filters': {
+		'$title': {
+			'$contains': 'pie'
+		}
+	},
+	'sort': {
+		'$datePublished': 'ASC'
+	},
+	'page': 1,
+	'size': 20
+}
+
+collectionItems = elemeno.getCollectionItems('recipes', options);
+```
+
+## API Overview
+
+### Singles
+
+#### `elemeno.getSingles([options])`
+
+```ruby
+options = {
+	'sort': {
+		'$dateUpdated': 'DESC'
+	},
+	'page': 1,
+	'size': 20
+}
+
+singles = elemeno.getSingles(options)
+```
+
+#### `elemeno.getSingle(singleSlug)`
+
+```ruby
+single = elemeno.getSingle('about')
+```
+
+### Collections
+
+#### `elemeno.getCollections([options])`
+
+```ruby
+options = {
+	'sort': {
+		'$dateCreated': 'DESC'
+	},
+	'page': 1,
+	'size': 20
+}
+
+collections = `elemeno.getCollections(options)
+```
+
+#### `elemeno.getCollection(collectionSlug)`
+
+```ruby
+collection = `elemeno.getCollection('recipes')
+```
+
+#### `elemeno.getCollectionItems(collectionSlug, [options])`
+
+```ruby
+options = {
+	'filters': {
+		'$title': {
+			'$contains': 'pie'
+		}
+	},
+	'sort': {
+		'$datePublished': 'ASC'
+	},
+	'page': 1,
+	'size': 20
+}
+
+collectionItems = elemeno.getCollectionsItems('recipes', options)
+```
+
+#### `elemeno.getCollectionItems(collectionSluge, itemSlug, [options])`
+
+```ruby
+collectionItem = elemeno.getCollectionItem('recipes', 'applie-pie')
+```
+
+or `byId`:
+
+```ruby
+options = {
+	'byId': true
+}
+
+collectionItem = elemeno.getCollectionItem('recipes', '281cf9b2-b355-11e6-b10e-5b3ff757fea2', options)
+```

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/elemeno.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'elemeno/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "elemeno"
+  spec.version       = Elemeno::VERSION
+  spec.authors       = ["Chris Erwin", "Dave Bobak"]
+  spec.email         = ["chris@elemeno.io", "dave@elemeno.io"]
+
+  spec.summary       = %q{Elemeno Ruby Client}
+  spec.description   = %q{Official Ruby Client for Elemeno, an API based CMS.}
+  spec.homepage      = "https://elemeno.io"
+  spec.license       = "MIT"
+  spec.required_ruby_version = '>= 1.9'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+
+  spec.add_dependency "faraday", "~> 0.10"
+end

data/lib/elemeno.rb

@@ -0,0 +1,74 @@
+require "elemeno/version"
+require "faraday"
+require "json"
+
+module Elemeno
+	class Client
+
+		@@singleBase = 'singles/'
+		@@collectionBase = 'collections/'
+
+		def initialize(api_key)
+			@conn = Faraday.new :url => 'https://api.elemeno.io/v1/', :headers => {'Authorization' => api_key}
+		end
+
+		private def get(path, query = nil)
+			response = @conn.get do |req|
+				req.url path
+				if query
+					req.params = query
+				end
+			end
+
+			return JSON.parse(response.body)
+		end
+
+		private def getQuery(options = nil, allow = false)
+			query = Hash.new
+
+			if options && options.is_a?(Hash)
+				if options.has_key?(:filters) && allow.is_a?(Array) && allow.include?('filters')
+					query['filters'] = options[:filters].to_json
+				end
+				if options.has_key?(:sort) && allow.is_a?(Array) && allow.include?('sort')
+					query['sort'] = options[:sort].to_json
+				end
+				if options.has_key?(:page)
+					query['page'] = options[:page].to_json
+				end
+				if options.has_key?(:size)
+					query['size'] = options[:size].to_json
+				end
+				if options.has_key?(:byId)
+					query['byId'] = (options[:byId].is_a?(TrueClass) || options[:byId] == 'true') ? true : false
+				end
+			end
+
+			return query
+		end
+
+		def getSingles(options = nil)
+			return get(@@singleBase, getQuery(options, ['sort']))
+		end
+
+		def getSingle(singleSlug)
+			return get(@@singleBase + singleSlug)
+		end
+
+		def getCollections(options = nil)
+			return get(@@collectionBase, getQuery(options, ['sort']))
+		end
+
+		def getCollection(collectionSlug)
+			return get(@@collectionBase + collectionSlug)
+		end
+
+		def getCollectionItems(collectionSlug, options = nil)
+			return get(@@collectionBase + collectionSlug + '/items', getQuery(options, ['filters', 'sort']))
+		end
+
+		def getCollectionItem(collectionSlug, itemSlug, options = nil)
+			return get(@@collectionBase + collectionSlug + '/items/' + itemSlug, getQuery(options, ['sort']))
+		end
+	end
+end

data/lib/elemeno/version.rb

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

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: elemeno
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Chris Erwin
+- Dave Bobak
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-12-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+description: Official Ruby Client for Elemeno, an API based CMS.
+email:
+- chris@elemeno.io
+- dave@elemeno.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".editorconfig"
+- ".gitignore"
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- elemeno.gemspec
+- lib/elemeno.rb
+- lib/elemeno/version.rb
+homepage: https://elemeno.io
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '1.9'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.8
+signing_key: 
+specification_version: 4
+summary: Elemeno Ruby Client
+test_files: []