buttercms-ruby 1.9 → 2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a0f437a3187e885b9c7250f9afbe5ff41cebb2dbc84127dd36ae0963b34fcba1
-  data.tar.gz: 2a9673e85ef2155f5b55f2febe48932dacf28fc4d7e7fdf4ffa050cb18d69c49
+  metadata.gz: f315c57a5804e6b7817e7f840f85e406ccccd73021ebdfbb5e84e9fad8ea7475
+  data.tar.gz: aa26b058d512ebf1ff34aa5edef920517a8ba893a775949c1c61b173dc9421a1
 SHA512:
-  metadata.gz: 46738145c68da934fc76e9a8e3c8fdaa2ee8e9462e8c07ed69af2ad557cb1e659a657fc164f1573d9d9a5f0fd35b8eceec046f2fae2c40dbe5a518c374cd970a
-  data.tar.gz: f47192c16cf33c9557aa151e90db0538bf3e3a31dd03e68fe4666cd72093b1c6f95414d640d1121a19eabc491dcbdb10939a8940175de409d7ebcabef4268a65
+  metadata.gz: b28741a244c0b3ca0e05adc58518754b65fe6d5713ccb6bd22b1948064db992cc894e0fb9b2e1e38df83fc76e996e2aa0cee3f8badc6dd226406fcfc2548610b
+  data.tar.gz: ac4decef965cc92fadf790ebbb3925a676e3874434c8b192f58f5286aaa10e53dd91d4d74ad6fe28a40fd7c9d5eddc05624719a136fa7167c98847f3d45313ec

data/README.md

@@ -39,7 +39,10 @@ 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
 pages = ButterCMS::Page.list('news', params)
+
 page = ButterCMS::Page.get('news', 'hello-world', params)
+
+pages = ButterCMS::Page.search('query', params)
 ```
 
 ## Collections

data/buttercms-ruby.gemspec

@@ -7,8 +7,8 @@ Gem::Specification.new do |s|
   s.name = "buttercms-ruby"
   s.version = ButterCMS::VERSION
   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.summary = 'Ruby API client for ButterCMS'
+  s.description = 'Butter is the #1 developer rated headless CMS. See https://buttercms.com for details.'
   s.authors = ["ButterCMS"]
   s.email= ["support@buttercms.com"]
   s.homepage = "https://buttercms.com/docs"

data/lib/buttercms/page.rb

@@ -15,5 +15,11 @@ module ButterCMS
 
       self.create_object(response)
     end
+
+    def self.search(query = '', options = {})
+      response = ButterCMS.request('/pages/search/', {query: query}.merge(options))
+      
+      self.create_collection(response)
+    end
   end
 end

data/lib/buttercms/version.rb

@@ -1,3 +1,3 @@
 module ButterCMS
-  VERSION = '1.9'
+  VERSION = '2.2'
 end

data/lib/buttercms-ruby.rb

@@ -3,6 +3,7 @@ require 'ostruct'
 require 'logger'
 require 'uri'
 require 'net/http'
+require 'pathname'
 
 require "buttercms/errors"
 require 'buttercms/version'
@@ -71,7 +72,13 @@ module ButterCMS
       query[:test] = 1
     end
 
-    path = "#{@api_url.path}#{URI.encode_www_form(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|

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: buttercms-ruby
 version: !ruby/object:Gem::Version
-  version: '1.9'
+  version: '2.2'
 platform: ruby
 authors:
 - ButterCMS
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-26 00:00:00.000000000 Z
+date: 2022-04-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -38,8 +38,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Butter is a blogging platform loved by engineers. See https://buttercms.com
-  for details.
+description: 'Butter is the #1 developer rated headless CMS. See https://buttercms.com
+  for details.'
 email:
 - support@buttercms.com
 executables: []
@@ -98,7 +98,7 @@ requirements: []
 rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
-summary: A simple Ruby client for the buttercms.com REST API
+summary: Ruby API client for ButterCMS
 test_files:
 - spec/lib/butter-ruby_spec.rb
 - spec/lib/buttercms/butter_collection_spec.rb