buttercms-ruby 1.4 → 1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 6892f2c65b2714c507d356db4c7a0fa1ca0efe53
-  data.tar.gz: aeee01cf3ad4a68c8fe365124db34e494dbf9ca1
+SHA256:
+  metadata.gz: 348ca14f5f921c18ed7368f6f49bc97f9649304fa55e64ee1819515060bfbe01
+  data.tar.gz: 00e814b0baece7fcf1bba2fc29d16ae42c17b47ab32e796b48c249db922357ef
 SHA512:
-  metadata.gz: 7f71a3ae6a84b213bc03c42c96b0217d1241a8f812c4f1b9acb8ef968293a4d5a5db6e727316e5f5b290dabd3c5219df02ef58a03360cf4bd845bf199e9a4d12
-  data.tar.gz: 7a3afc5ae7c6a3c7f0d3c41b48a63bbdd43bd4107cfbffb7cad501ba40d8461168f2d95726bb45d40509938fb7495a741d4f6994c410f9abc96877ee5fd200d1
+  metadata.gz: 5584f22c5db27a1556bea7370aaf02137b9ffdcf0f613899bad05e85ddfd2795d82ff9f94c0fe1f96b3c2e04dc6659bab08df68e85a80528cfa267307de542b7
+  data.tar.gz: '0215907376576dc8605406b2983aad57aa3fecdb800e3c291178c94a5cf97f84442236c4138d76c22c0ae088c3ca6e7b2d5a725c73b98f603910a4a7197bc157'

data/.gitignore

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

data/README.md

@@ -44,8 +44,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 +135,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/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'
+  VERSION = '1.5'
 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_resource_spec.rb

@@ -11,7 +11,7 @@ describe ButterCMS::ButterResource do
   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 +24,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.5'
 platform: ruby
 authors:
 - ButterCMS
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-18 00:00:00.000000000 Z
+date: 2019-12-10 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