buttercms-ruby 1.3.2 → 1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c7b4c68f74294cbca04ea1d4c68fa40f241a5f92
-  data.tar.gz: 124e11b182d91dc136042d7a2ae35a09e4e19d2c
+  metadata.gz: 6892f2c65b2714c507d356db4c7a0fa1ca0efe53
+  data.tar.gz: aeee01cf3ad4a68c8fe365124db34e494dbf9ca1
 SHA512:
-  metadata.gz: e4eb9a5fab1a68b855786b401a5870deb6d962d1b00bca58b2cfa1e44d975b5d5721361944c8192597c5b5866964f166411d46c38e4be88e4c460a3682c619fe
-  data.tar.gz: 8560d77aee2ad9615c0f6ec985a9badb83c6cf95e00ff35fac70289bf6421e89919670558f8e31351c4fc4561c56249755e49753cc6259e724f98857aa1c9395
+  metadata.gz: 7f71a3ae6a84b213bc03c42c96b0217d1241a8f812c4f1b9acb8ef968293a4d5a5db6e727316e5f5b290dabd3c5219df02ef58a03360cf4bd845bf199e9a4d12
+  data.tar.gz: 7a3afc5ae7c6a3c7f0d3c41b48a63bbdd43bd4107cfbffb7cad501ba40d8461168f2d95726bb45d40509938fb7495a741d4f6994c410f9abc96877ee5fd200d1

data/README.md

@@ -30,26 +30,31 @@ To setup your project, follow these steps:
 
 ## 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
 
-```ruby
-ButterCMS::Content.fetch(['homepage_headline'])
+https://buttercms.com/docs/api/?ruby#retrieve-a-collection
 
-# Localization
-ButterCMS::Content.fetch(['homepage_headline'], locale: 'es')
+```ruby
+params = {page: 1, page_size: 10, locale: 'en', preview: 1, fields.headline: 'foo bar', levels: 2} # optional
+ButterCMS::Content.fetch(['testimonials'], 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 +66,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
 

data/VERSION

@@ -1 +1 @@
-1.3.2
+1.4

data/lib/buttercms-ruby.rb

@@ -27,6 +27,7 @@ module ButterCMS
 
   class << self
     attr_accessor :api_token
+    attr_accessor :write_api_token
     attr_accessor :test_mode
     attr_accessor :read_timeout
     attr_reader :data_store
@@ -71,13 +72,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 +122,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: 2.0,
+      read_timeout: read_timeout || 5.0,
+      ssl_timeout:  2.0,
+      use_ssl:      @api_url.scheme == "https",
+    }
+  end
 end

data/lib/buttercms/butter_resource.rb

@@ -25,6 +25,12 @@ 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
+      resource_path + "*/#{id}/"
+    end
 
     def self.resource_path
       raise "resource_path must be set"
@@ -41,6 +47,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
 

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'
+  VERSION = '1.4'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: buttercms-ruby
 version: !ruby/object:Gem::Version
-  version: 1.3.2
+  version: '1.4'
 platform: ruby
 authors:
 - ButterCMS
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-20 00:00:00.000000000 Z
+date: 2019-10-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec