sanity-ruby 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0c4121d2a2289a431f6f938b61f275a3d06daebcf8821e02530cfe79b0c00979
-  data.tar.gz: 350cd01bf81655b2c46d60255055a47979b388803f5f83efbc1590e2bc908266
+  metadata.gz: 99698b9c87c062e3b1ba260579a51d00913b28690bba2eef557c5ab3ffe43a61
+  data.tar.gz: 0cc88772721d519604f1ffb3fecd38d456c4fcff8b5de036dbf7f932b537d13f
 SHA512:
-  metadata.gz: 95e189e52382c065a9f70123f1fe789c8bdb81e62399e6da73e3f4a4ec30f07f3d8d95239774421aa786edfac4ed4cfd44b5edb093abc37b9a7064f844d666b2
-  data.tar.gz: 6b2d7c915b3350d01374ae53425b108b156f97c4633575a79e4094553756fe16a17038398096f5801fbe8cd866decb040f571ce5580026d02fd399a053d5ce3a
+  metadata.gz: b2f9cf2fd8dece545f5ac80878fa99910b440b9ac78dc318b26f619da6103f9940c477a4431b7129626fd1c157b31a2ee6679fe32092e7be0add78d926a93f52
+  data.tar.gz: 7bda92a9734b5415abb245067dc1971b6a2239bdcd66b6710b14e5cb10fada6e4bb73c71e47a0fd4e65500c5bb7406b3e8274c4648c5cdde47ced1904d72cf09

data/README.md

@@ -3,23 +3,25 @@
 ![](https://github.com/morning-brew/sanity-ruby/actions/workflows/ci.yml/badge.svg)
 <a href="https://codeclimate.com/github/morning-brew/sanity-ruby/maintainability"><img src="https://api.codeclimate.com/v1/badges/1984ee6eb0bce46a2469/maintainability" /></a>
 
-The Sanity Ruby library provides convenient access to the Sanity API from applications written in Ruby. It includes a pre-defined set of classes for API resources that initialize themselves dynamically from API responses when applicable.
+The Sanity Ruby library provides convenient access to the Sanity API from applications written in Ruby. It includes a pre-defined set of classes for API resources.
 
-The library also provides other features. For example:
+The library also provides other features, like:
 
-  - Easy configuration for fast setup and use.
-  - A pre-defined class to help make any PORO a "sanity resource"
-  - Extensibility in overriding the wrapper of your API response results
-  - A small DSL around GROQ queries
+- Easy configuration for fast setup and use.
+- A pre-defined class to help make any PORO a "sanity resource"
+- Extensibility in overriding the wrapper of your API response results
+- A small DSL around GROQ queries
 
 ## Contents
 
-- [Getting Started](#getting-started)
-- [Mutating](#mutating)
-- [Querying](#querying)
-- [Development](#development)
-- [Contributing](#contributing)
-- [License](#license)
+- [Sanity](#sanity)
+  - [Contents](#contents)
+  - [Getting Started](#getting-started)
+  - [Mutating](#mutating)
+  - [Querying](#querying)
+  - [Development](#development)
+  - [Contributing](#contributing)
+  - [License](#license)
 
 ## Getting Started
 
@@ -29,12 +31,33 @@ Add this line to your application's Gemfile:
 gem 'sanity-ruby'
 ```
 
+Setup your configuration. If using in Rails, consider setting this in an initializer:
+
+```ruby
+Sanity.configure do |s|
+  s.token = "yoursupersecrettoken"
+  s.api_version = "v2021-03-25"
+  s.project_id = "1234"
+  s.dataset = "development"
+  s.use_cdn = false
+end
+```
+
 To create a new document:
 
 ```ruby
 Sanity::Document.create(params: {_type: "user", first_name: "Carl", last_name: "Sagan"})
 ```
 
+You can also return the created document ID.
+
+```ruby
+res = Sanity::Document.create(params: {_type: "user", first_name: "Carl", last_name: "Sagan"}, options: {return_ids: true})
+
+# JSON.parse(res.body)["results"]
+# > [{"id"=>"1fc471c6434fdc654ba447", "operation"=>"create"}]
+```
+
 To create a new asset:
 
 ```ruby
@@ -119,10 +142,6 @@ Sanity::Document.find(_id: "1234-321")
 
 To find documents based on certain fields:
 
-```ruby
-Sanity::Document.where(_id: "1234-321", slug: "foobar")
-```
-
 [Where](https://www.sanity.io/docs/query-cheat-sheet#3949cadc7524)
 
 _majority supported_
@@ -178,26 +197,37 @@ select: [:_id, :slug, :title, :name]
 ```ruby
 Sanity::Document.where(_type: "user", select: %i[first_name last_name])
 ```
- 
+
 Should you need more advanced querying that isn't handled in this gem's DSL you can pass a raw groq query
 
 [Query Cheat Sheet](https://www.sanity.io/docs/query-cheat-sheet)
 
 ```ruby
-Sanity::Document.where(groq: "*[_type=='movie']{title,poster{asset->{path,url}}}")
+groq_query = <<-GROQ
+  *[ _type =='movie' && name == $name] {
+    title,
+    poster {
+      asset-> {
+        path,
+        url
+      }
+    }
+  }
+GROQ
+
+Sanity::Document.where(groq: groq_query, variables: {name: "Monsters, Inc."})
 ```
 
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
-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).
+To install this gem onto your local machine, run `bundle exec rake install`.
 
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/morning-brew/sanity-ruby.
 
-
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/sanity/attributable.rb

@@ -47,7 +47,7 @@ module Sanity
           define_singleton_method(key) { args[key] }
         end
 
-        instance_variable_set("@attributes", attrs)
+        instance_variable_set(:@attributes, attrs)
       end
     end
 

data/lib/sanity/configuration.rb

@@ -24,6 +24,11 @@ module Sanity
       @token = ""
       @use_cdn = false
     end
+
+    # @return [String] Api subdomain based on use_cdn flag
+    def api_subdomain
+      use_cdn ? "apicdn" : "api"
+    end
   end
 
   def self.configuration

data/lib/sanity/http/mutation.rb

@@ -10,7 +10,7 @@ module Sanity
         def included(base)
           base.extend(ClassMethods)
           base.extend(Forwardable)
-          base.delegate(%i[project_id api_version dataset token] => :"Sanity.config")
+          base.delegate(%i[project_id api_version dataset token api_subdomain] => :"Sanity.config")
           base.delegate(mutatable_api_endpoint: :resource_klass)
         end
       end
@@ -66,7 +66,7 @@ module Sanity
       private
 
       def base_url
-        "https://#{project_id}.api.sanity.io/#{api_version}/#{mutatable_api_endpoint}/#{dataset}"
+        "https://#{project_id}.#{api_subdomain}.sanity.io/#{api_version}/#{mutatable_api_endpoint}/#{dataset}"
       end
 
       def body

data/lib/sanity/http/query.rb

@@ -11,7 +11,7 @@ module Sanity
         def included(base)
           base.extend(ClassMethods)
           base.extend(Forwardable)
-          base.delegate(%i[project_id api_version dataset token] => :"Sanity.config")
+          base.delegate(%i[project_id api_version dataset token api_subdomain] => :"Sanity.config")
         end
       end
 
@@ -56,7 +56,7 @@ module Sanity
       end
 
       def base_url
-        "https://#{project_id}.api.sanity.io/#{api_version}/#{api_endpoint}/#{dataset}"
+        "https://#{project_id}.#{api_subdomain}.sanity.io/#{api_version}/#{api_endpoint}/#{dataset}"
       end
 
       def headers

data/lib/sanity/mutatable.rb

@@ -49,7 +49,7 @@ module Sanity
           end
         end
 
-        define_singleton_method("mutatable_api_endpoint") { options.fetch(:api_endpoint, "") }
+        define_singleton_method(:mutatable_api_endpoint) { options.fetch(:api_endpoint, "") }
       end
     end
   end

data/lib/sanity/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Sanity
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/sanity-ruby.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require "sanity"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sanity-ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Morning Brew
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-07-29 00:00:00.000000000 Z
+date: 2022-02-25 00:00:00.000000000 Z
 dependencies: []
 description: ''
 email: tech@morningbrew.com
@@ -26,6 +26,7 @@ files:
 - bin/console
 - bin/setup
 - bin/standardrb
+- lib/sanity-ruby.rb
 - lib/sanity.rb
 - lib/sanity/attributable.rb
 - lib/sanity/configuration.rb
@@ -64,7 +65,7 @@ metadata:
   homepage_uri: https://github.com/morning-brew/sanity-ruby
   source_code_uri: https://github.com/morning-brew/sanity-ruby
   changelog_uri: https://github.com/morning-brew/sanity-ruby
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -79,8 +80,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: Ruby bindings for the Sanity API
 test_files: []