refinerycms-api-wrapper 1.0.0.beta

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b7aa23e103c741c468459761e621ac3558157882
+  data.tar.gz: c76dac967bcfb3aa611ec3d10e431d7ef26eca1b
+SHA512:
+  metadata.gz: 5bd8eff457bdeb0e7cc1f038d744fce5139830173b20fd3481fbf88b2ccf1e756cbb961c52560f57c60f6fd3c92d6ab54ee125050b811c51b069943c63d580db
+  data.tar.gz: 27c40e30d3f5158a95119bc32fb6fea15117a287bac465361c9b411232f30b2743a6b7ad7eb15df78a1debe6162f288a7708b6873faf367b8849e155286c2477

data/.gitignore

@@ -0,0 +1,39 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+.gems
+.rbenv-*
+.ruby-version

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.sample.env

@@ -0,0 +1,3 @@
+REFINERYCMS_API_TOKEN=
+REFINERYCMS_API_URL=
+REFINERYCMS_API_PATH=

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in refinery-api.gemspec
+gemspec
+
+group :development, :test do
+  gem 'dotenv'
+end

data/Gemfile.lock

@@ -0,0 +1,65 @@
+PATH
+  remote: .
+  specs:
+    refinerycms-api-wrapper (1.0.0.beta)
+      faraday
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.4.0)
+    coderay (1.1.1)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.2.5)
+    dotenv (2.1.1)
+    faraday (0.9.2)
+      multipart-post (>= 1.2, < 3)
+    hashdiff (0.3.0)
+    method_source (0.8.2)
+    multipart-post (2.0.0)
+    pry (0.10.4)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rack (2.0.1)
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    rake (10.5.0)
+    rspec (3.5.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+    rspec-core (3.5.1)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-mocks (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
+    safe_yaml (1.0.4)
+    slop (3.6.0)
+    vcr (3.0.3)
+    webmock (2.1.0)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.11)
+  dotenv
+  pry
+  rack-test (~> 0.6.3)
+  rake (~> 10.0)
+  refinerycms-api-wrapper!
+  rspec (~> 3.0)
+  vcr
+  webmock
+
+BUNDLED WITH
+   1.12.5

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Rockets of Awesome
+
+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/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Ian Rodriguez
+
+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,57 @@
+# Refinery CMS API Wrapper
+
+[![Build Status](https://travis-ci.org/refinerycms-contrib/refinerycms-api-wrapper.svg?branch=master)](https://travis-ci.org/refinerycms-contrib/refinerycms-api-wrapper)
+
+A Ruby library for working with the The Refinery CMS REST API.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'refinerycms-api-wrapper'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install refinerycms-api-wrapper
+
+## Usage
+
+Configure a connection to the API:
+
+```ruby
+Refinery::API.configure do |conf|
+  conf.api_token = "123"
+  conf.api_url = "http://localhost:3000"
+  conf.api_path = "/api/v1"
+end
+```
+
+Make your first call:
+
+```ruby
+client = Refinery::API::Pages.new
+pages = client.index.body
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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/[USERNAME]/refinerycms-api-wrapper.
+
+
+## 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,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 "refinery/api"
+
+# 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/lib/refinery/api.rb

@@ -0,0 +1,22 @@
+require "refinery/api/version"
+require "refinery/api/configuration"
+require "refinery/api/pages"
+require "refinery/api/resources"
+require "refinery/api/images"
+require "refinery/api/blog/posts"
+require "refinery/api/inquiries/inquiries"
+
+require "faraday"
+
+module Refinery
+  module API
+    class << self
+      attr_accessor :configuration
+    end
+
+    def self.configure
+      self.configuration ||= Configuration.new
+      yield(configuration)
+    end
+  end
+end

data/lib/refinery/api/blog/posts.rb

@@ -0,0 +1,42 @@
+require "refinery/api/helpers/client_helper"
+
+module Refinery
+  module API
+    module Blog
+      class Posts
+        include Refinery::API::Helpers::ClientHelper
+
+        def index
+          config.connection.get(posts_path)
+        end
+
+        def show(id:)
+          config.connection.get(posts_path(id))
+        end
+
+        def create(post:)
+          config.connection.post(posts_path) do |req|
+            req.body = post.to_json
+          end
+        end
+
+        def update(id:, post:)
+          config.connection.put(posts_path(id)) do |req|
+            req.body = post.to_json
+          end
+        end
+
+        def destroy(id:)
+          config.connection.delete(posts_path(id))
+        end
+
+        private
+          def posts_path(id = nil)
+            path = api_path + "/blog/posts"
+            path << "/#{id}" if id
+            path
+          end
+      end
+    end
+  end
+end

data/lib/refinery/api/configuration.rb

@@ -0,0 +1,24 @@
+require "faraday"
+
+module Refinery
+  module API
+    class Configuration
+      attr_accessor :api_token, :api_url, :api_path
+
+      def initialize
+        @api_token = ""
+        @api_url = ""
+        @api_path = "/api"
+      end
+
+      def connection
+        @_connection ||= ::Faraday.new(url: api_url,
+          headers: { "X-Refinery-Token" => api_token,
+            "Content-Type" => "application/json" }) do |faraday|
+              faraday.request :url_encoded
+              faraday.adapter Faraday.default_adapter
+        end
+      end
+    end
+  end
+end

data/lib/refinery/api/helpers/client_helper.rb

@@ -0,0 +1,15 @@
+module Refinery
+  module API
+    module Helpers
+      module ClientHelper
+        def config
+          @_config ||= Refinery::API.configuration
+        end
+
+        def api_path
+          Refinery::API.configuration.api_path
+        end
+      end
+    end
+  end
+end

data/lib/refinery/api/images.rb

@@ -0,0 +1,40 @@
+require "refinery/api/helpers/client_helper"
+
+module Refinery
+  module API
+    class Images
+      include Refinery::API::Helpers::ClientHelper
+
+      def index
+        config.connection.get(images_path)
+      end
+
+      def show(id:)
+        config.connection.get(images_path(id))
+      end
+
+      def create(image:)
+        config.connection.post(images_path) do |req|
+          req.body = image.to_json
+        end
+      end
+
+      def update(id:, image:)
+        config.connection.put(images_path(id)) do |req|
+          req.body = image.to_json
+        end
+      end
+
+      def destroy(id:)
+        config.connection.delete(images_path(id))
+      end
+
+      private
+        def images_path(id = nil)
+          path = api_path + "/images"
+          path << "/#{id}" if id
+          path
+        end
+    end
+  end
+end

data/lib/refinery/api/inquiries/inquiries.rb

@@ -0,0 +1,36 @@
+require "refinery/api/helpers/client_helper"
+
+module Refinery
+  module API
+    module Inquiries
+      class Inquiries
+        include Refinery::API::Helpers::ClientHelper
+
+        def index
+          config.connection.get(inquiries_path)
+        end
+
+        def show(id:)
+          config.connection.get(inquiries_path(id))
+        end
+
+        def create(inquiry:)
+          config.connection.post(inquiries_path) do |req|
+            req.body = inquiry.to_json
+          end
+        end
+
+        def destroy(id:)
+          config.connection.delete(inquiries_path(id))
+        end
+
+        private
+          def inquiries_path(id = nil)
+            path = api_path + "/inquiries/inquiries"
+            path << "/#{id}" if id
+            path
+          end
+      end
+    end
+  end
+end

data/lib/refinery/api/pages.rb

@@ -0,0 +1,40 @@
+require "refinery/api/helpers/client_helper"
+
+module Refinery
+  module API
+    class Pages
+      include Refinery::API::Helpers::ClientHelper
+
+      def index
+        config.connection.get(pages_path)
+      end
+
+      def show(id:)
+        config.connection.get(pages_path(id))
+      end
+
+      def create(page:)
+        config.connection.post(pages_path) do |req|
+          req.body = page.to_json
+        end
+      end
+
+      def update(id:, page:)
+        config.connection.put(pages_path(id)) do |req|
+          req.body = page.to_json
+        end
+      end
+
+      def destroy(id:)
+        config.connection.delete(pages_path(id))
+      end
+
+      private
+        def pages_path(id = nil)
+          path = api_path + "/pages"
+          path << "/#{id}" if id
+          path
+        end
+    end
+  end
+end

data/lib/refinery/api/resources.rb

@@ -0,0 +1,40 @@
+require "refinery/api/helpers/client_helper"
+
+module Refinery
+  module API
+    class Resources
+      include Refinery::API::Helpers::ClientHelper
+
+      def index
+        config.connection.get(resources_path)
+      end
+
+      def show(id:)
+        config.connection.get(resources_path(id))
+      end
+
+      def create(resource:)
+        config.connection.post(resources_path) do |req|
+          req.body = resource.to_json
+        end
+      end
+
+      def update(id:, resource:)
+        config.connection.put(resources_path(id)) do |req|
+          req.body = resource.to_json
+        end
+      end
+
+      def destroy(id:)
+        config.connection.delete(resources_path(id))
+      end
+
+      private
+        def resources_path(id = nil)
+          path = api_path + "/resources"
+          path << "/#{id}" if id
+          path
+        end
+    end
+  end
+end

data/lib/refinery/api/version.rb

@@ -0,0 +1,5 @@
+module Refinery
+  module API
+    VERSION = "1.0.0.beta"
+  end
+end

data/refinerycms-api-wrapper.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'refinery/api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "refinerycms-api-wrapper"
+  spec.version       = Refinery::API::VERSION
+  spec.authors       = ["Brice Sanchez", "Ian Rodriguez"]
+
+  spec.summary       = %q{This wraps the Refinery CMS API in a simple yet flexible way.}
+  spec.description   = %q{Interact with Refinery CMS API using this awesome gem.}
+  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 "faraday"
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rack-test", "~> 0.6.3"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "vcr"
+  spec.add_development_dependency "webmock"
+  spec.add_development_dependency "pry"
+end

metadata

@@ -0,0 +1,178 @@
+--- !ruby/object:Gem::Specification
+name: refinerycms-api-wrapper
+version: !ruby/object:Gem::Version
+  version: 1.0.0.beta
+platform: ruby
+authors:
+- Brice Sanchez
+- Ian Rodriguez
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-07-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !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: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.3
+- !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: '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: vcr
+  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: webmock
+  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: pry
+  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: Interact with Refinery CMS API using this awesome gem.
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".sample.env"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/refinery/api.rb
+- lib/refinery/api/blog/posts.rb
+- lib/refinery/api/configuration.rb
+- lib/refinery/api/helpers/client_helper.rb
+- lib/refinery/api/images.rb
+- lib/refinery/api/inquiries/inquiries.rb
+- lib/refinery/api/pages.rb
+- lib/refinery/api/resources.rb
+- lib/refinery/api/version.rb
+- refinerycms-api-wrapper.gemspec
+homepage: 
+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: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: This wraps the Refinery CMS API in a simple yet flexible way.
+test_files: []