buttercms-ruby 1.7 → 2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2c4b746f372b9a3255947360799f205470880bf4e0c07b45ffbf0bc9ce2ca107
-  data.tar.gz: 2ff93eef484952c2e236af4e28f69e922d58ddaf20d7dcfd76d1ef9f30a80685
+  metadata.gz: 3d847c56b05ed132a90cf0bbcb42f0bc192062a0abb9df0b55bbba6cd8f7afbf
+  data.tar.gz: 961e13a3d995664f1dd0998a19682cf262169cd696df2c3a944238c023cddc67
 SHA512:
-  metadata.gz: 277dd34304c21ab48b6e479d9c8a76bd6c504bac3059452da754728dd062ee3ab7c271c6bec91b6d295121452e08bc9dd51c7cdea09c699438aebd802ec3f0a8
-  data.tar.gz: f1e8800efbb85ecf77cfea176068b93b4d73e9f6d7fa3bc9784b41af4d862ef9d2bcca861bb5f5c61389bd6a36b6744ad45046c7ab3d65ed4bee332b0e447ccc
+  metadata.gz: d27637d790c3671f530a2a0f9899d8fbd846ae3ded2d190099b2567b74375e263229cc0ad74fd1170bfb0fa3b7bfb6f5ccd3b10b553c5d7b35180c53bc1ec81e
+  data.tar.gz: 5b24961cce8dfba0cacf0d55b156d8d562808db660bfc10fa606ab807db262a9726c1921b9e1953b42b63ba681fe79412c9db06516aee53573def2146dc1f5f9

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
@@ -36,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.7'
+  VERSION = '2.1'
 end

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/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.7'
+  version: '2.1'
 platform: ruby
 authors:
 - ButterCMS
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-03 00:00:00.000000000 Z
+date: 2022-01-14 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