dato 0.6.1 → 0.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 70dd4b90e6cad917e774b7bb8566d84b1f24008a7bc22a18804ef1c81239fc48
-  data.tar.gz: 26b6cda172ba266c6d9d4ee7dee2895ae168ddbf9e5fab90ab91323fd1bb4aa9
+  metadata.gz: e329219fdc49be66749f4f2b31747b18f347b35732d5c72b33fc6b824811f51d
+  data.tar.gz: 702e5c6547e278cc8175bdfee6ecf5c36075f8f6ceaabf467e93c3bb89eab5af
 SHA512:
-  metadata.gz: 6d8851990f86b88040e6dc19e9825a94d9ef2b2f6282bee9b198bd0e7ded9834495d78821d157eb8a63fcd9391805834e39efae98171a68457b2df27ab801e1d
-  data.tar.gz: 547fc2a37677fb5bfc6a1c4866276d873eea7221ae5a6754d7119776cc29d5bcbe0408521318e7687973e9f7a0113ffdc787525b5d5847058e3f15a552fd3b21
+  metadata.gz: 5d7c8e2e8b43806eb37f1e9da47ce2fcd375f1c09bdcd32fafc3c92b312b0ab4f13d3f6c37cc74bf525d0b368461cd8e7d7d178763339044bba976d47a21675a
+  data.tar.gz: '0078f5dce062b0336ff1169d149cf6978d65c07101e5ac007a855abc03a7c179fc5dab7661f3c0d206104b5f47bae0dbb39a2bcc563d0da47e25d3c75282960f'

data/CHANGELOG.md

@@ -0,0 +1,51 @@
+# v0.6.1
+
+The big change is that the methods the client makes available are  generated at runtime based on the [JSON Schema of our CMA](https://www.datocms.com/content-management-api/). This means any new API endpoint — or changes to existing ones — will instantly be reflected to the client, without the need to upgrade to the latest client version.
+
+We also added a new `deserialize_response` option to every call, that you can use if you want to retrieve the exact payload the DatoCMS returns:
+
+```ruby
+require "dato"
+client = Dato::Site::Client.new("YOUR-API-KEY")
+
+# `deserialize_response` is true by default:
+access_token = client.access_tokens.create(name: "New token", role: "34")
+
+# {
+#   "id" => "312",
+#   "hardcoded_type" => nil,
+#   "name" => "New token",
+#   "token" => "XXXX",
+#   "role" => "34"
+# }
+
+# if `deserialize_response` is false, this will be the result
+access_token = client.access_tokens.create({ name: "New token", role: "34" }, deserialize_response: false)
+
+# {
+#   "data": {
+#     "type": "access_token",
+#     "id": "312",
+#     "attributes": {
+#       "name": "New token",
+#       "token": "XXXX",
+#       "hardcoded_type": nil
+#     },
+#     "relationships": {
+#       "role": {
+#         "data": {
+#           "type": "role",
+#           "id": "34"
+#         }
+#       }
+#     }
+#   }
+# }
+```
+
+In our doc pages we also added some examples for the super-handy `all_pages` option which was already present since v0.3.29:
+
+```ruby
+# if you want to fetch all the pages with just one call:
+client.items.all({ "filter[type]" => "44" }, all_pages: true)
+```

data/README.md

@@ -6,7 +6,7 @@ CLI tool for DatoCMS (https://www.datocms.com).
 
 ## How to integrate DatoCMS with Jekyll
 
-Please head over the [Jekyll section of our documentation](https://docs.datocms.com/jekyll/overview.html) to learn everything you need to get started.
+Please head over the [Jekyll section of our documentation](https://www.datocms.com/docs/jekyll/) to learn everything you need to get started.
 
 ## How to integrate DatoCMS with Middleman
 
@@ -14,7 +14,7 @@ For Middleman we have created a nice Middleman extension called [middleman-dato]
 
 ## API Client
 
-This gem also exposes an API client, useful ie. to import existing content in your DatoCMS administrative area. Read our [documentation](https://docs.datocms.com/api-client/ruby.html) for detailed info.
+This gem also exposes an API client, useful ie. to import existing content in your DatoCMS administrative area. Read our [documentation](https://www.datocms.com/content-management-api/) for detailed info.
 
 ## Development
 
@@ -22,10 +22,6 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
-### Updating the client when the API changes
-
-The DatoCMS API provides an always up-to-date [JSON Hyperschema](http://json-schema.org/latest/json-schema-hypermedia.html): the code of this gem is generated automatically starting from the schema running `rake regenerate`.
-
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/datocms/ruby-datocms-client. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.

data/dato.gemspec

@@ -24,7 +24,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'rubyzip'
-  spec.add_development_dependency 'json_schema'
   spec.add_development_dependency 'simplecov'
   spec.add_development_dependency 'vcr'
   spec.add_development_dependency 'webmock'
@@ -45,4 +44,5 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'dotenv'
   spec.add_runtime_dependency 'pusher-client'
   spec.add_runtime_dependency 'listen'
+  spec.add_runtime_dependency 'json_schema'
 end

data/lib/dato/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module Dato
-  VERSION = '0.6.1'
+  VERSION = '0.6.2'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dato
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.6.2
 platform: ruby
 authors:
 - Stefano Verna
@@ -66,20 +66,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: json_schema
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -346,6 +332,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: json_schema
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Ruby client for DatoCMS API
 email:
 - s.verna@cantierecreativo.net
@@ -359,6 +359,7 @@ files:
 - ".rubocop.yml"
 - ".ruby-version"
 - ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt