buttercms-ruby 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f72c57972718778708f150fa6a31a9576c1c299a
+  data.tar.gz: 74afaa24b20838aee3b6fe474e68a63dbcd9b771
+SHA512:
+  metadata.gz: c651afb1629f09e01435d04b48be8d67c1eeb02c5da3d06c63bcb827d0763434b110f98b9abdc73c60445bfed7f5366177d7f17692bd235913d650766bbca411
+  data.tar.gz: ef78a1f79753a75fd5e0500c045d9da04861c98057040cacb1f5ea4988bc9a2597e80d8b0ec71d2abf1822116026053e8216ffd0f34e5dceb0001257e0bf948b

data/.gitignore

@@ -0,0 +1,20 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.DS_Store
+.ruby-version
+.rvmrc

data/.rspec

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

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'rake'
+
+group :development, :test do
+  gem 'rspec-rails'
+end

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Butter
+https://buttercms.com/
+
+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,40 @@
+# ButterCMS API Ruby Client
+
+## Setup
+
+To setup your project, follow these steps:
+
+1. Install using `gem install buttercms-ruby` or by adding to your `Gemfile`:
+
+  ```ruby
+  gem 'buttercms-ruby', '~>1.0.0'
+  ```
+
+2. Set your API token.
+
+  ```ruby
+  require 'buttercms-ruby'
+
+  ButterCMS::api_token = "YourToken"
+  ```
+
+## Quick Start
+
+```ruby
+posts = ButterCMS::Post.all(page: 1, page_size: 10)
+puts posts.first.title
+puts posts.meta.next_page
+
+post = ButterCMS::Post.find("post-slug")
+puts post.title
+
+author = ButterCMS::Author.find("author-slug")
+puts author.first_name
+
+category = ButterCMS::Category.find("author-slug")
+puts category.name
+
+rss_feed = ButterCMS::Feed.find(:rss)
+puts rss_feed.data
+```
+

data/Rakefile

@@ -0,0 +1,5 @@
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new('spec')
+
+task :default => :spec

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/buttercms-ruby.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.unshift(File.join(File.dirname(__FILE__), 'lib'))
+
+require 'buttercms/version'
+
+Gem::Specification.new do |s|
+  s.name = "buttercms-ruby"
+  s.version = ButterCMS::VERSION
+  s.required_ruby_version = '>= 1.9.3'
+  s.require_paths = ["lib"]
+  s.summary = 'A simple Ruby client for the buttercms.com REST API'
+  s.description = 'Butter is a blogging platform loved by engineers. See https://buttercms.com for details.'
+  s.authors = ["ButterCMS"]
+  s.email= ["support@buttercms.com"]
+  s.homepage = "https://buttercms.com/docs"
+  s.license = 'MIT'
+
+  s.add_dependency 'rest-client'
+
+  s.add_development_dependency 'rspec', '~> 2.7'
+  s.add_development_dependency 'webmock'
+
+  s.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.files = `git ls-files`.split("\n")
+  s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
+end

data/lib/buttercms-ruby.rb

@@ -0,0 +1,39 @@
+require 'json'
+require 'rest_client'
+require 'ostruct'
+
+require 'buttercms/hash_to_object'
+require 'buttercms/butter_collection'
+require 'buttercms/butter_resource'
+require 'buttercms/author'
+require 'buttercms/category'
+require 'buttercms/post'
+require 'buttercms/feed'
+
+module ButterCMS
+  @api_url = 'https://api.buttercms.com/v2'
+  @token = nil
+
+  def self.api_token=(token)
+    @token = token
+  end
+
+  def self.token
+    @token
+  end
+
+  def self.endpoint
+    @api_url
+  end
+
+  def self.request(path, options = {})
+    raise ArgumentError.new "Please set your API token" unless token
+
+    response = RestClient.get(endpoint + path,
+      {accept: :json, authorization: "Token #{@token}", params: options})
+
+
+    JSON.parse(response.body)
+  end
+end
+

data/lib/buttercms/author.rb

@@ -0,0 +1,7 @@
+module ButterCMS
+  class Author < ButterResource
+    def self.resource_path
+      "/authors"
+    end
+  end
+end

data/lib/buttercms/butter_collection.rb

@@ -0,0 +1,21 @@
+module ButterCMS
+  class ButterCollection
+    include Enumerable
+
+    attr_reader :meta
+
+    def initialize(klass, json)
+      data = json["data"]
+      meta = json["meta"]
+
+      @meta = HashToObject.convert(meta) if meta
+      @items = data.map {|o| klass.new("data" => o) }
+    end
+
+    def each(&block)
+      @items.each do |member|
+        block.call(member)
+      end
+    end
+  end
+end

data/lib/buttercms/butter_resource.rb

@@ -0,0 +1,54 @@
+module ButterCMS
+  class ButterResource
+    attr_reader :meta, :data
+
+    def initialize(json)
+      data = json["data"]
+      meta = json["meta"]
+
+      @json = json
+      @data = HashToObject.convert(data)
+      @meta = HashToObject.convert(meta) if meta
+
+      data.each do |key, value|
+        instance_variable_set("@#{key}", @data.send(key))
+        self.class.send(:attr_reader, key)
+      end
+    end
+
+    def inspect
+      id_string = (self.respond_to?(:id) && !self.id.nil?) ? " id=#{self.id}" : ""
+      "#<#{self.class}:0x#{self.object_id.to_s(16)}#{id_string}> JSON: " + JSON.pretty_generate(@json)
+    end
+
+    def self.endpoint(id = '')
+      resource_path + '/' + id.to_s
+    end
+
+    def self.resource_path
+      raise "resource_path must be set"
+    end
+
+    def self.all(options = {})
+      response = ButterCMS.request(self.endpoint, options)
+
+      self.create_collection(response)
+    end
+
+    def self.find(id, options = {})
+      response = ButterCMS.request(self.endpoint(id), options)
+
+      self.create_object(response)
+    end
+
+    private
+
+    def self.create_collection(response)
+      ButterCollection.new(self, response)
+    end
+
+    def self.create_object(response)
+      self.new(response)
+    end
+  end
+end

data/lib/buttercms/category.rb

@@ -0,0 +1,7 @@
+module ButterCMS
+  class Category < ButterResource
+    def self.resource_path
+      "/categories"
+    end
+  end
+end

data/lib/buttercms/feed.rb

@@ -0,0 +1,7 @@
+module ButterCMS
+  class Feed < ButterResource
+    def self.resource_path
+      "/feeds"
+    end
+  end
+end

data/lib/buttercms/hash_to_object.rb

@@ -0,0 +1,7 @@
+module ButterCMS
+  class HashToObject
+    def self.convert(hash)
+      JSON.parse(hash.to_json, object_class: OpenStruct)
+    end
+  end
+end

data/lib/buttercms/post.rb

@@ -0,0 +1,7 @@
+module ButterCMS
+  class Post < ButterResource
+    def self.resource_path
+      "/posts"
+    end
+  end
+end

data/lib/buttercms/version.rb

@@ -0,0 +1,3 @@
+module ButterCMS
+  VERSION = '1.0.0'
+end

data/spec/lib/butter-ruby_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe ButterCMS do
+  describe '.request' do
+    context 'with an api token' do
+      before do
+        ButterCMS.stub(:token).and_return('test123')
+      end
+
+      it 'should make an api request' do
+        stub_request(:get, ButterCMS.endpoint).to_return(body: JSON.generate({data: {test: 'test'}}))
+        expect{ ButterCMS.request('') }.to_not raise_error
+      end
+    end
+
+    context 'without an api token' do
+      it 'should throw an argument error' do
+        expect{ ButterCMS.request() }.to raise_error(ArgumentError)
+      end
+    end
+  end
+end

data/spec/lib/buttercms/butter_collection_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+describe ButterCMS::ButterCollection do
+  let(:json) { {"data" => ["foo"], "meta" => {}} }
+  let(:klass) { double('klass', :new => 'bar') }
+
+  it 'implements #meta' do
+    collection = ButterCMS::ButterCollection.new(klass, json)
+
+    expect(collection.meta).to be_a(OpenStruct)
+  end
+
+  it 'implements #count' do
+    collection = ButterCMS::ButterCollection.new(klass, json)
+
+    expect(collection.count).to eq 1
+  end
+end

data/spec/lib/buttercms/butter_resource_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+
+describe ButterCMS::ButterResource do
+  describe '.all' do
+    before do
+      ButterCMS.stub(:token).and_return('test123')
+      ButterCMS.stub(:request).and_return({"data" => [{"attribute" => 'test'}]})
+
+      ButterCMS::ButterResource.stub(:resource_path).
+        and_return('')
+    end
+
+    it 'should make a request with the correct endpoint' do
+      expect(ButterCMS).to receive(:request).with('/', {})
+      ButterCMS::ButterResource.all()
+    end
+
+    it 'should return a collection' do
+      objects = ButterCMS::ButterResource.all
+      expect(objects).to be_a(ButterCMS::ButterCollection)
+      expect(objects.first).to be_a(ButterCMS::ButterResource)
+    end
+  end
+
+  describe '.find' do
+    before do
+      ButterCMS.stub(:token).and_return('test123')
+      ButterCMS.stub(:request).and_return({"data" => {"attribute" => 'test'}})
+
+      ButterCMS::ButterResource.stub(:resource_path).
+        and_return('')
+    end
+
+    it 'should make a request with the correct endpoint' do
+      expect(ButterCMS).to receive(:request).with('/1', {})
+      ButterCMS::ButterResource.find(1)
+    end
+
+    it 'should return one object' do
+      expect(ButterCMS::ButterResource.find(1)).to be_a(ButterCMS::ButterResource)
+    end
+  end
+end

data/spec/lib/buttercms/hash_to_object_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe ButterCMS::HashToObject do
+  describe '.convert' do
+    it 'converts hash to object' do
+      hash = {
+        "key1" => "value",
+        "key2" => {
+          "nested_key" => "nested value"
+        }
+      }
+
+      obj = ButterCMS::HashToObject.convert(hash)
+
+      expect(obj.key1).to eq 'value'
+      expect(obj.key2.nested_key).to eq "nested value"
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+$:.unshift File.expand_path('..', __FILE__)
+$:.unshift File.expand_path('../../lib', __FILE__)
+
+require 'rubygems'
+require 'bundler/setup'
+require 'rspec'
+require 'webmock/rspec'
+require 'buttercms-ruby'

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: buttercms-ruby
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- ButterCMS
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-02-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+- !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'
+description: Butter is a blogging platform loved by engineers. See https://buttercms.com
+  for details.
+email:
+- support@buttercms.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- VERSION
+- buttercms-ruby.gemspec
+- lib/buttercms-ruby.rb
+- lib/buttercms/author.rb
+- lib/buttercms/butter_collection.rb
+- lib/buttercms/butter_resource.rb
+- lib/buttercms/category.rb
+- lib/buttercms/feed.rb
+- lib/buttercms/hash_to_object.rb
+- lib/buttercms/post.rb
+- lib/buttercms/version.rb
+- spec/lib/butter-ruby_spec.rb
+- spec/lib/buttercms/butter_collection_spec.rb
+- spec/lib/buttercms/butter_resource_spec.rb
+- spec/lib/buttercms/hash_to_object_spec.rb
+- spec/spec_helper.rb
+homepage: https://buttercms.com/docs
+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.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: A simple Ruby client for the buttercms.com REST API
+test_files:
+- spec/lib/butter-ruby_spec.rb
+- spec/lib/buttercms/butter_collection_spec.rb
+- spec/lib/buttercms/butter_resource_spec.rb
+- spec/lib/buttercms/hash_to_object_spec.rb
+- spec/spec_helper.rb