buttercms-ruby 1.4 → 1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 6892f2c65b2714c507d356db4c7a0fa1ca0efe53
-  data.tar.gz: aeee01cf3ad4a68c8fe365124db34e494dbf9ca1
+SHA256:
+  metadata.gz: a0f437a3187e885b9c7250f9afbe5ff41cebb2dbc84127dd36ae0963b34fcba1
+  data.tar.gz: 2a9673e85ef2155f5b55f2febe48932dacf28fc4d7e7fdf4ffa050cb18d69c49
 SHA512:
-  metadata.gz: 7f71a3ae6a84b213bc03c42c96b0217d1241a8f812c4f1b9acb8ef968293a4d5a5db6e727316e5f5b290dabd3c5219df02ef58a03360cf4bd845bf199e9a4d12
-  data.tar.gz: 7a3afc5ae7c6a3c7f0d3c41b48a63bbdd43bd4107cfbffb7cad501ba40d8461168f2d95726bb45d40509938fb7495a741d4f6994c410f9abc96877ee5fd200d1
+  metadata.gz: 46738145c68da934fc76e9a8e3c8fdaa2ee8e9462e8c07ed69af2ad557cb1e659a657fc164f1573d9d9a5f0fd35b8eceec046f2fae2c40dbe5a518c374cd970a
+  data.tar.gz: f47192c16cf33c9557aa151e90db0538bf3e3a31dd03e68fe4666cd72093b1c6f95414d640d1121a19eabc491dcbdb10939a8940175de409d7ebcabef4268a65

data/.gitignore

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

data/README.md

@@ -26,6 +26,9 @@ 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
@@ -34,7 +37,7 @@ https://buttercms.com/docs/api/?ruby#pages
 
 
 ```ruby
-params = {page: 1, page_size: 10, locale: 'en', preview: 1, fields.headline: 'foo bar', levels: 2} # 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)
 ```
@@ -44,8 +47,12 @@ page = ButterCMS::Page.get('news', 'hello-world', params)
 https://buttercms.com/docs/api/?ruby#retrieve-a-collection
 
 ```ruby
-params = {page: 1, page_size: 10, locale: 'en', preview: 1, fields.headline: 'foo bar', levels: 2} # optional
-ButterCMS::Content.fetch(['testimonials'], params)
+# 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)
+
+# 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 Collections or for testing content during local development. To fetch content from test mode add the following configuration:
 ButterCMS::test_mode = true
@@ -131,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

@@ -30,6 +30,7 @@ module ButterCMS
     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
@@ -70,7 +71,7 @@ module ButterCMS
       query[:test] = 1
     end
 
-    path = "#{@api_url.path}#{URI.encode(path)}?#{URI.encode_www_form(query)}"
+    path = "#{@api_url.path}#{URI.encode_www_form(path)}?#{URI.encode_www_form(query)}"
 
     response =
       Net::HTTP.start(@api_url.host, @api_url.port, http_options) do |http|
@@ -172,7 +173,7 @@ module ButterCMS
   
   def self.http_options
     {
-      open_timeout: 2.0,
+      open_timeout: open_timeout || 2.0,
       read_timeout: read_timeout || 5.0,
       ssl_timeout:  2.0,
       use_ssl:      @api_url.scheme == "https",

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
@@ -25,7 +32,7 @@ module ButterCMS
       # API expects all endpoints to include trailing slashes
       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
@@ -47,14 +54,14 @@ 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/")
@@ -76,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/version.rb

@@ -1,3 +1,3 @@
 module ButterCMS
-  VERSION = '1.4'
-end
+  VERSION = '1.9'
+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.4'
+  version: '1.9'
 platform: ruby
 authors:
 - ButterCMS
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-18 00:00:00.000000000 Z
+date: 2021-03-26 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.4