buttercms-ruby 1.5 → 2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 348ca14f5f921c18ed7368f6f49bc97f9649304fa55e64ee1819515060bfbe01
-  data.tar.gz: 00e814b0baece7fcf1bba2fc29d16ae42c17b47ab32e796b48c249db922357ef
+  metadata.gz: 69371855dc4fc9883ba72a8eabd2ede8e8b5118a79b0435457da54609bde25f4
+  data.tar.gz: 72c527a3185fc8ed00eb56735bc4e2f3abe343058214cef23ce6debba066c169
 SHA512:
-  metadata.gz: 5584f22c5db27a1556bea7370aaf02137b9ffdcf0f613899bad05e85ddfd2795d82ff9f94c0fe1f96b3c2e04dc6659bab08df68e85a80528cfa267307de542b7
-  data.tar.gz: '0215907376576dc8605406b2983aad57aa3fecdb800e3c291178c94a5cf97f84442236c4138d76c22c0ae088c3ca6e7b2d5a725c73b98f603910a4a7197bc157'
+  metadata.gz: 3c7f9c52c35df85a8ed5f38a3531deddee771529bbb2717c5d5b2cca2a788503a0aecea2672be6bb5f22837a1b453ecbcef7d4f4856dea4b7060e7fc98b74ebf
+  data.tar.gz: 70f72d7bf27b9532904b37aff8c40d1060d33511f34d4bcc2d6c0c24aa24ab19f3a9d587b1d132390a672ecfa5c99172ea2c1880cff33263666ce5bf3330d42b

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)
 ```
@@ -45,7 +48,7 @@ https://buttercms.com/docs/api/?ruby#retrieve-a-collection
 
 ```ruby
 # 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
+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.

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,13 @@ module ButterCMS
       query[:test] = 1
     end
 
-    path = "#{@api_url.path}#{URI.encode(path)}?#{URI.encode_www_form(query)}"
+    # If the user has passed in a "/" leading path, don't interpret that
+    # as wanting to get rid of the API prefix
+    if path.start_with?("/")
+      path = path[1..-1]
+    end
+
+    path = Pathname.new(@api_url.path).join(path).to_s + "?#{URI.encode_www_form(query)}"
 
     response =
       Net::HTTP.start(@api_url.host, @api_url.port, http_options) do |http|
@@ -172,7 +179,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/version.rb

@@ -1,3 +1,3 @@
 module ButterCMS
-  VERSION = '1.5'
-end
+  VERSION = '2.0'
+end

data/spec/lib/butter-ruby_spec.rb

@@ -14,6 +14,22 @@ describe ButterCMS do
         ButterCMS.request('')
         expect(request).to have_been_made
       end
+
+      it "should properly escape paths" do
+        request = stub_request(
+          :get,
+          "https://api.buttercms.com/v2/pages/*/homepage%20en?auth_token=test123"
+        ).to_return(body: JSON.generate({data: {test: 'test'}}))
+
+        # support leading slashes
+        ButterCMS.request('/pages/*/homepage en')
+
+        # and no leading slashes
+        ButterCMS.request('pages/*/homepage en')
+
+
+        expect(request).to have_been_made.twice
+      end
     end
 
     context 'without an api token' do

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,6 +8,17 @@ 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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: buttercms-ruby
 version: !ruby/object:Gem::Version
-  version: '1.5'
+  version: '2.0'
 platform: ruby
 authors:
 - ButterCMS
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-10 00:00:00.000000000 Z
+date: 2021-04-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec