buttercms-ruby 1.3.2 → 1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c7b4c68f74294cbca04ea1d4c68fa40f241a5f92
-  data.tar.gz: 124e11b182d91dc136042d7a2ae35a09e4e19d2c
+SHA256:
+  metadata.gz: 2a4629771fdc42b53b03a97bb2488e52cebcaa99e08812927fdb3e9a51ab9bd4
+  data.tar.gz: 9b7044c488d00e7a800233f36b167cb880f48931d27abfac68c8c699174cf314
 SHA512:
-  metadata.gz: e4eb9a5fab1a68b855786b401a5870deb6d962d1b00bca58b2cfa1e44d975b5d5721361944c8192597c5b5866964f166411d46c38e4be88e4c460a3682c619fe
-  data.tar.gz: 8560d77aee2ad9615c0f6ec985a9badb83c6cf95e00ff35fac70289bf6421e89919670558f8e31351c4fc4561c56249755e49753cc6259e724f98857aa1c9395
+  metadata.gz: 3018b0ab7b461986646e43733bf769ff3fd06a868fe7eef970b623c6558f8d689903bf144889572cf6c8a6bd23a3d6f63dba6135947c54d09ab1650eba43b865
+  data.tar.gz: aee9e833f1f9422e5609b8b16f273fd5db5b6d188b25b3502e8831e8a572c438a1ad03445103138d77907bcad98f4e51da3cd92dae6dec178cbad39b4656c43e

data/.gitignore

@@ -19,4 +19,5 @@ tmp
 .ruby-version
 .rvmrc
 *.rdb
-*.store
+*.store
+test.rb

data/README.md

@@ -26,30 +26,42 @@ To setup your project, follow these steps:
 
   # Set read timeout (Default is 5.0)
   # ButterCMS::read_timeout = 5.0
+
+  # Set open timeout (Default is 2.0)
+  # ButterCMS::open_timeout = 2.0
   ```
 
 ## Pages
 
+https://buttercms.com/docs/api/?ruby#pages
+
+
 ```ruby
-params = {foo: 'bar'} # optional
+params = {page: 1, page_size: 10, locale: 'en', preview: 1, 'fields.headline': 'foo bar', levels: 2} # optional
 pages = ButterCMS::Page.list('news', params)
 page = ButterCMS::Page.get('news', 'hello-world', params)
 ```
 
-## Content Fields
+## Collections
+
+https://buttercms.com/docs/api/?ruby#retrieve-a-collection
 
 ```ruby
-ButterCMS::Content.fetch(['homepage_headline'])
+# list each instance of a given collection with meta data for fetching the next page.
+params = { page: 1, page_size: 10, locale: 'en', preview: 1, 'fields.headline': 'foo bar', levels: 2 } # optional
+ButterCMS::Content.list('collection1', params)
 
-# Localization
-ButterCMS::Content.fetch(['homepage_headline'], locale: 'es')
+# list instances for multiple collections, this will not return meta data for pagination control.
+ButterCMS::Content.fetch(['collection1', 'collection2'], params)
 
-# Test mode can be used to setup a staging website for previewing Content Fields or for testing content during local development. To fetch content from test mode add the following configuration:
+# Test mode can be used to setup a staging website for previewing Collections or for testing content during local development. To fetch content from test mode add the following configuration:
 ButterCMS::test_mode = true
 ```
 
 ## Blog Engine
 
+https://buttercms.com/docs/api/?ruby#blog-engine
+
 ```ruby
 posts = ButterCMS::Post.all({:page => 1, :page_size => 10})
 puts posts.first.title
@@ -61,6 +73,39 @@ puts posts.first.title
 post = ButterCMS::Post.find("post-slug")
 puts post.title
 
+# Create a Post.
+ButterCMS::write_api_token = "YourWriteToken"
+ButterCMS::Post.create({
+  slug: 'blog-slug',
+  title: 'blog-title'
+})
+
+# Update a Post
+ButterCMS::Post.update('blog-slug', {
+  title: 'blog-title-v2'
+})
+
+# Create a page
+ButterCMS::Page.create({
+  slug: 'page-slug',
+  title: 'page-title',
+  status: 'published',
+  "page-type": 'page_type',
+  fields: {
+    meta_title: 'test meta title'
+  }
+})
+
+# update a Page
+ButterCMS::Page.update('page-slug-2', {
+  status: 'published',
+  fields: {
+    meta_title: 'test meta title'
+  }
+})
+
+
+
 author = ButterCMS::Author.find("author-slug")
 puts author.first_name
 
@@ -93,3 +138,5 @@ ButterCMS::logger = MyLogger.new
 ### Other
 
 View Ruby [Blog engine](https://buttercms.com/ruby-blog-engine/) and [Full CMS](https://buttercms.com/ruby-cms/) for other examples of using ButterCMS with Ruby.
+
+### Development

data/lib/buttercms-ruby.rb

@@ -27,8 +27,10 @@ module ButterCMS
 
   class << self
     attr_accessor :api_token
+    attr_accessor :write_api_token
     attr_accessor :test_mode
     attr_accessor :read_timeout
+    attr_accessor :open_timeout
     attr_reader :data_store
     attr_writer :logger
   end
@@ -71,13 +73,6 @@ module ButterCMS
 
     path = "#{@api_url.path}#{URI.encode(path)}?#{URI.encode_www_form(query)}"
 
-    http_options = {
-      open_timeout: 2.0,
-      read_timeout: read_timeout || 5.0,
-      ssl_timeout:  2.0,
-      use_ssl:      @api_url.scheme == "https",
-    }
-
     response =
       Net::HTTP.start(@api_url.host, @api_url.port, http_options) do |http|
         request = Net::HTTP::Get.new(path)
@@ -128,4 +123,60 @@ module ButterCMS
 
     return JSON.parse(result)
   end
+  
+  def self.write_request(path, options = {})
+    raise ArgumentError.new "Please set your write API token" unless write_api_token
+    result = write_api_request(path, options)
+
+    return JSON.parse(result)
+  end
+  
+  def self.write_api_request(path, options = {})
+    query = options.dup
+    token_for_request = query.delete(:auth_token) || write_api_token
+
+    path = "#{@api_url.path}#{URI.encode(path)}"
+
+    response =
+      Net::HTTP.start(@api_url.host, @api_url.port, http_options) do |http|
+        write_type = query.delete(:method) || "Post"
+        request_type = "Net::HTTP::#{write_type}".constantize
+        request = request_type.new(path)
+        request["User-Agent"] = "ButterCMS/Ruby #{ButterCMS::VERSION}"
+        request["Accept"]     = "application/json"
+        request["Content-Type"] = "application/json"
+        request["Authorization"] = "Token #{token_for_request}"
+        request.body = query.except(:auth_token).to_json
+
+        http.request(request)
+      end
+
+    case response
+    when Net::HTTPNotFound
+      raise ::ButterCMS::NotFound, JSON.parse(response.body)["detail"]
+    when Net::HTTPBadRequest
+      parsed_body = JSON.parse(response.body)
+      errors = if parsed_body.is_a?(Array)
+        parsed_body.join(' ')
+      else
+        parsed_body.map do |k, v|
+          "#{k}: #{v}"
+        end.join(" ")
+      end
+      raise ::ButterCMS::BadRequest, errors
+    end
+
+    response.body
+  end
+  
+  private
+  
+  def self.http_options
+    {
+      open_timeout: open_timeout || 2.0,
+      read_timeout: read_timeout || 5.0,
+      ssl_timeout:  2.0,
+      use_ssl:      @api_url.scheme == "https",
+    }
+  end
 end

data/lib/buttercms/butter_collection.rb

@@ -2,6 +2,7 @@ module ButterCMS
   class ButterCollection
     include Enumerable
 
+    attr_reader :items
     attr_reader :meta
 
     def initialize(klass, json)
@@ -18,4 +19,4 @@ module ButterCMS
       end
     end
   end
-end
+end

data/lib/buttercms/butter_resource.rb

@@ -7,12 +7,19 @@ module ButterCMS
       @data = HashToObject.convert(json["data"])
       @meta = HashToObject.convert(json["meta"]) if json["meta"]
 
-      if json["data"].is_a?(Hash)
-        json["data"].each do |key, value|
-          instance_variable_set("@#{key}", @data.send(key))
-          self.class.send(:attr_reader, key)
-        end
-      end
+      define_attribute_methods(@data)
+    end
+
+    def marshal_dump
+      { json: @json, data: @data, meta: @meta }
+    end
+
+    def marshal_load(dump)
+      @json = dump[:json]
+      @data = dump[:data]
+      @meta = dump[:meta]
+
+      define_attribute_methods(@data)
     end
 
     def inspect
@@ -26,6 +33,12 @@ module ButterCMS
       resource_path + (id ? "#{id}/" : '')
     end
 
+    def self.patch_endpoint(id)
+      # Append trailing slash when id is added to path because
+      # API expects all endpoints to include trailing slashes
+      resource_path + "*/#{id}/"
+    end
+
     def self.resource_path
       raise "resource_path must be set"
     end
@@ -42,6 +55,25 @@ module ButterCMS
       self.create_object(response)
     end
 
+    def self.create(options = {})
+      options[:method] = 'Post'
+      response = ButterCMS.write_request(self.endpoint, options)
+
+      self.create_object(response)
+    end
+
+    def self.update(id, options = {})
+      options[:method] = 'Patch'
+      _endpoint = if resource_path.include?("/pages/")
+        self.patch_endpoint(id)
+      else
+        self.endpoint(id)
+      end
+      response = ButterCMS.write_request(_endpoint, options)
+
+      self.create_object(response)
+    end
+
     private
 
     def self.create_collection(response)
@@ -51,5 +83,14 @@ module ButterCMS
     def self.create_object(response)
       self.new(response)
     end
+
+    def define_attribute_methods(methods)
+      return unless methods.respond_to?(:each_pair)
+
+      methods.each_pair do |key, value|
+        instance_variable_set("@#{key}", value)
+        self.class.send(:attr_reader, key)
+      end
+    end
   end
 end

data/lib/buttercms/content.rb

@@ -1,22 +1,19 @@
 module ButterCMS
-  class Content
-    attr_reader :data
-
-    def initialize(json)
-      @json = json
-      @data = HashToObject.convert(json["data"])
-    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)
+  class Content < ButterResource
+    def self.resource_path
+      "/content/"
     end
 
-    def self.fetch(keys = [], options = {})
-      params = {keys: keys.join(',')}.merge(options)
-
-      response = ButterCMS.request("/content/", params)
+    def self.list(collection_slug, options = {})
+      response = ButterCMS.request(self.endpoint(collection_slug), options)
 
+      self.create_collection(response)
+    end
+    
+    def self.fetch(collection_slugs, options = {})
+      params = { keys: collection_slugs.join(',') }.merge(options)
+      response = ButterCMS.request(self.resource_path, params)
+      
       self.new(response)
     end
   end

data/lib/buttercms/errors.rb

@@ -6,4 +6,7 @@ module ButterCMS
   # NotFound is raised when a resource cannot be found
   class NotFound < Error
   end
+  
+  class BadRequest < Error
+  end
 end

data/lib/buttercms/version.rb

@@ -1,3 +1,3 @@
 module ButterCMS
-  VERSION = '1.3.2'
-end
+  VERSION = '1.8'
+end

data/lib/console.rb

@@ -0,0 +1,10 @@
+require 'bundler/inline'
+
+gemfile do
+  source 'https://rubygems.org'
+  gem 'buttercms-ruby', :path => '../buttercms-ruby'
+end
+
+# start a REPL session
+ButterCMS::api_token = "" # add your dev token here
+binding.irb

data/spec/lib/buttercms/butter_collection_spec.rb

@@ -4,6 +4,12 @@ describe ButterCMS::ButterCollection do
   let(:json) { {"data" => ["foo"], "meta" => {}} }
   let(:klass) { double('klass', :new => 'bar') }
 
+  it 'implements #items' do
+    collection = ButterCMS::ButterCollection.new(klass, json)
+
+    expect(collection.items).to match_array(["bar"])
+  end
+
   it 'implements #meta' do
     collection = ButterCMS::ButterCollection.new(klass, json)
 
@@ -15,4 +21,20 @@ describe ButterCMS::ButterCollection do
 
     expect(collection.count).to eq 1
   end
-end
+
+  # Marshal.load (used by Rails for caching) was not restoring the ButterResource's dynamic methods
+  # See https://github.com/ButterCMS/buttercms-ruby/issues/13
+  describe 'marshal load' do
+    subject { described_class.new(ButterCMS::ButterResource, 'data' => [{ 'name' => 'Test Name', 'description' => 'Test Description' }]) }
+
+    it 'restores the ButterResource dynamic methods' do
+      collection = Marshal.load(Marshal.dump(subject))
+      resource = collection.first
+
+      aggregate_failures do
+        expect(resource.name).to eq('Test Name')
+        expect(resource.description).to eq('Test Description')
+      end
+    end
+  end
+end

data/spec/lib/buttercms/butter_resource_spec.rb

@@ -8,10 +8,21 @@ describe ButterCMS::ButterResource do
     allow(ButterCMS::ButterResource).to receive(:resource_path).and_return('')
   end
 
+  describe 'auto-generated methods' do
+    let(:resource) { described_class.new('data' => { 'name' => 'Test Name', 'description' => 'Test Description' }) }
+
+    it 'creates attribute reader methods for data pairs' do
+      aggregate_failures do
+        expect(resource.name).to eq('Test Name')
+        expect(resource.description).to eq('Test Description')
+      end
+    end
+  end
+
   describe '.all' do
 
     it 'should make a request with the correct endpoint' do
-      expect(ButterCMS).to receive(:request).with('/', {})
+      expect(ButterCMS).to receive(:request).with('', {})
       ButterCMS::ButterResource.all()
     end
 
@@ -24,7 +35,7 @@ describe ButterCMS::ButterResource do
 
   describe '.find' do
     it 'should make a request with the correct endpoint' do
-      expect(ButterCMS).to receive(:request).with('/1', {})
+      expect(ButterCMS).to receive(:request).with('1/', {})
       ButterCMS::ButterResource.find(1)
     end
 

data/spec/lib/buttercms/content_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+describe ButterCMS::Content do
+  before do
+    allow(ButterCMS).to receive(:token).and_return('test123')
+    allow(ButterCMS).to receive(:request).and_return({
+      "meta"=>{
+        "next_page"=>2, 
+        "previous_page"=>nil, 
+        "count"=>2
+        }, 
+      "data"=>{
+        "author"=>[
+          { "name"=>"Charles Dickens"},
+          { "name"=>"J.K. Rowling"}
+        ]
+      }
+    })
+    
+    @response = ButterCMS::Content.list('slug', {
+      page: 1,
+      page_size: 2
+    })
+  end
+  
+  it "has meta and collection info" do
+    expect(@response.meta.next_page).to eq(2)
+    expect(@response.to_a.first.data.first).to eq('author')
+    expect(@response.to_a.first.data.last.first).to have_attributes(
+      name: "Charles Dickens"
+    )
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: buttercms-ruby
 version: !ruby/object:Gem::Version
-  version: 1.3.2
+  version: '1.8'
 platform: ruby
 authors:
 - ButterCMS
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-20 00:00:00.000000000 Z
+date: 2020-07-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -52,7 +52,6 @@ files:
 - LICENSE
 - README.md
 - Rakefile
-- VERSION
 - buttercms-ruby.gemspec
 - lib/buttercms-ruby.rb
 - lib/buttercms/author.rb
@@ -69,10 +68,12 @@ files:
 - lib/buttercms/post.rb
 - lib/buttercms/tag.rb
 - lib/buttercms/version.rb
+- lib/console.rb
 - lib/core_ext/ostruct.rb
 - spec/lib/butter-ruby_spec.rb
 - spec/lib/buttercms/butter_collection_spec.rb
 - spec/lib/buttercms/butter_resource_spec.rb
+- spec/lib/buttercms/content_spec.rb
 - spec/lib/buttercms/hash_to_object_spec.rb
 - spec/spec_helper.rb
 homepage: https://buttercms.com/docs
@@ -94,8 +95,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: A simple Ruby client for the buttercms.com REST API
@@ -103,5 +103,6 @@ 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/content_spec.rb
 - spec/lib/buttercms/hash_to_object_spec.rb
 - spec/spec_helper.rb

data/VERSION

@@ -1 +0,0 @@
-1.3.2