sanity-ruby 0.3.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6992c7a949150c3c6d2fc4f927e74f18b2b00d7158cb26905e195eb7d91da627
-  data.tar.gz: 0c2e2088e770fe98cff7a1522c6a39076a8efc43410ea9eb241311e2611cd1fe
+  metadata.gz: a6bf214154655cc746cb50c817499ddef2dc104915633814fb4bbb60dbcf18d6
+  data.tar.gz: 0e906831bd32ae8b98431adb107a1aca54ea0b6baa30327807cb0764f0a35c25
 SHA512:
-  metadata.gz: 2fff7714db16558133549a6cc8ed496cc2e157b17b533a44501ad125a0f7636d1575c9766939989711c7f957de7e6167cbd285963bbf8aac19bcdb7c2cde9377
-  data.tar.gz: 360d11148a57b4880b7cc661e4f7b7a51b8e2be937f991a4f1a6546fb21be348bd11123bba3d46eb71178a8c6aa628bcc107e7cee55ebeb613f4a80b4df5cdbe
+  metadata.gz: 99db43870e1f4ac67f63e46b142545c5588657d93eaee2eb007352a33646f36f5d7b31d1992b8dbca12eb98f92b9bab27ae8c0122637b3d0a3815f3eb1543b02
+  data.tar.gz: 9c09be7fec031eda815290b3e6dab1c2e080a7cb053eaf0274989181661d8e9f84c264ef798c7d17ee9b828a1fd2abae9fe17547f137d1f6dcb167768d5425eb

data/README.md

@@ -1,7 +1,7 @@
 # Sanity
 
-![](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>
+![](https://github.com/dvmonroe/sanity-ruby/actions/workflows/ci.yml/badge.svg)
+[![Maintainability](https://api.codeclimate.com/v1/badges/24b96780b59c8a871e6e/maintainability)](https://codeclimate.com/github/dvmonroe/sanity-ruby/maintainability)
 
 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.
 
@@ -44,6 +44,18 @@ Sanity.configure do |s|
 end
 ```
 
+or you can set the following ENV variables at runtime:
+
+```bash
+SANITY_TOKEN="yoursupersecrettoken"
+SANITY_API_VERSION="v2021-03-25"
+SANITY_PROJECT_ID="1234"
+SANITY_DATASET="development"
+SANITY_USE_CDN="false"
+```
+
+The configuration object is thread safe meaning you can connect to multiple different projects across multiple threads. This may be useful if your application is interacting with multiple different Sanity projects.
+
 To create a new document:
 
 ```ruby
@@ -70,9 +82,26 @@ To make any PORO a sanity resource:
 ```ruby
 class User < Sanity::Resource
   attribute :_id, default: ""
-  attribute :_type: default: ""
+  attribute :_type, default: ""
   mutatable only: %i(create delete)
   queryable
+  publishable
+end
+```
+
+
+
+Since `Sanity::Resource` includes `ActiveModel::Model` and
+`ActiveModel::Attributes`, you're able to define types on attributes and use
+methods like `alias_attribute`.
+
+```ruby
+class User < Sanity::Resource
+  ...
+  attribute :name, :string, default: 'John Doe'
+  attribute :_createdAt, :datetime
+  alias_attribute :created_at, :_createdAt
+  ...
 end
 ```
 
@@ -190,6 +219,20 @@ To [patch a document](https://www.sanity.io/docs/http-mutations#2f480b2baca5):
 Sanity::Document.patch(params: { _id: "1234-321", set: { first_name: "Carl" }})
 ```
 
+## Publishing
+
+To [publish a document](https://www.sanity.io/docs/scheduling-api#dcb47be520d0):
+
+```ruby
+Sanity::Document.publish(["1234-321"])
+```
+
+To [unpublish a document](https://www.sanity.io/docs/scheduling-api#64f3de350651):
+
+```ruby
+Sanity::Document.unpublish(["1234-321", "1432432-545"])
+```
+
 ## Querying
 
 To [find document(s) by id](https://www.sanity.io/docs/http-doc):
@@ -296,7 +339,7 @@ bin/dev-lint
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/morning-brew/sanity-ruby.
+Bug reports and pull requests are welcome on GitHub at https://github.com/dvmonroe/sanity-ruby.
 
 ## License
 

data/lib/sanity/attributable.rb

@@ -39,7 +39,7 @@ module Sanity
     def initialize(**args)
       self.class.default_attributes.merge(args).then do |attrs|
         attrs.each do |key, val|
-          define_singleton_method("#{key}=") do |val|
+          define_singleton_method(:"#{key}=") do |val|
             args[key] = val
             attributes[key] = val
           end

data/lib/sanity/configuration.rb

@@ -18,11 +18,11 @@ module Sanity
     attr_accessor :use_cdn
 
     def initialize
-      @project_id = ""
-      @dataset = ""
-      @api_version = ""
-      @token = ""
-      @use_cdn = false
+      @project_id = ENV.fetch("SANITY_PROJECT_ID", "")
+      @dataset = ENV.fetch("SANITY_DATASET", "")
+      @api_version = ENV.fetch("SANITY_API_VERSION", "")
+      @token = ENV.fetch("SANITY_TOKEN", "")
+      @use_cdn = ENV.fetch("SANITY_USE_CDN", false) == "true"
     end
 
     # @return [String] Api subdomain based on use_cdn flag
@@ -32,7 +32,7 @@ module Sanity
   end
 
   def self.configuration
-    @configuration ||= Configuration.new
+    Thread.current[:sanity_configuration] ||= Configuration.new
   end
 
   class << self
@@ -40,7 +40,7 @@ module Sanity
   end
 
   def self.configuration=(config)
-    @configuration = config
+    Thread.current[:sanity_configuration] = config
   end
 
   def self.configure

data/lib/sanity/helpers/type_helper.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Sanity
+  module TypeHelper
+    def self.default_type(klass)
+      return nil if klass == Sanity::Document
+
+      type = klass.to_s
+      type[0].downcase + type[1..]
+    end
+  end
+end

data/lib/sanity/helpers.rb

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

data/lib/sanity/http/mutation.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require "set"
+require "set" # rubocop:disable Lint/RedundantRequireStatement
 using Sanity::Refinements::Strings
 using Sanity::Refinements::Arrays
 

data/lib/sanity/http/publication.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+using Sanity::Refinements::Strings
+using Sanity::Refinements::Arrays
+
+module Sanity
+  module Http
+    module Publication
+      class << self
+        def included(base)
+          base.extend(ClassMethods)
+          base.extend(Forwardable)
+          base.delegate(%i[project_id dataset token] => :"Sanity.config")
+        end
+      end
+
+      module ClassMethods
+        def call(args)
+          new(args).call
+        end
+      end
+
+      attr_reader :args
+
+      def initialize(args)
+        unless args.is_a?(String) || args.is_a?(Array)
+          raise ArgumentError, "args must be a string or an array"
+        end
+        @args = Array.wrap(args)
+      end
+
+      def body_key
+        "documentId"
+      end
+
+      def call
+        Net::HTTP.post(uri, body.to_json, headers).then do |result|
+          block_given? ? yield(result) : result
+        end
+      end
+
+      def publication_path
+        self.class.name.demodulize.underscore.camelize_lower
+      end
+
+      private
+
+      def base_url
+        "https://api.sanity.io/v1/#{publication_path}/#{project_id}/#{dataset}"
+      end
+
+      def body
+        Array.wrap(args.map { |arg| {"#{body_key}": arg} })
+      end
+
+      def headers
+        {
+          "Content-Type": "application/json",
+          Authorization: "Bearer #{token}"
+        }
+      end
+
+      def uri
+        URI(base_url)
+      end
+    end
+  end
+end

data/lib/sanity/http/publish.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Sanity
+  module Http
+    class Publish
+      include Sanity::Http::Publication
+    end
+  end
+end

data/lib/sanity/http/unpublish.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Sanity
+  module Http
+    class Unpublish
+      include Sanity::Http::Publication
+    end
+  end
+end

data/lib/sanity/http.rb

@@ -6,6 +6,7 @@ require "uri"
 
 require "sanity/http/mutation"
 require "sanity/http/query"
+require "sanity/http/publication"
 
 require "sanity/http/create"
 require "sanity/http/create_if_not_exists"
@@ -13,6 +14,9 @@ require "sanity/http/create_or_replace"
 require "sanity/http/delete"
 require "sanity/http/patch"
 
+require "sanity/http/publish"
+require "sanity/http/unpublish"
+
 require "sanity/http/find"
 require "sanity/http/where"
 

data/lib/sanity/mutatable.rb

@@ -26,8 +26,9 @@ module Sanity
     end
 
     module ClassMethods
-      DEFAULT_KLASS_MUTATIONS = %i[create create_or_replace create_if_not_exists patch delete].freeze
-      DEFAULT_INSTANCE_MUTATIONS = %i[create create_or_replace create_if_not_exists delete].freeze
+      COMMON_MUTATIONS = %i[create create_or_replace create_if_not_exists delete].freeze
+      DEFAULT_KLASS_MUTATIONS = (COMMON_MUTATIONS + [:patch]).freeze
+      DEFAULT_INSTANCE_MUTATIONS = COMMON_MUTATIONS
       ALL_MUTATIONS = DEFAULT_KLASS_MUTATIONS | DEFAULT_INSTANCE_MUTATIONS
 
       private

data/lib/sanity/publishable.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Sanity
+  # Publishable is responsible for setting the appropriate class methods
+  # that invoke Sanity::Http's publishable actions
+  #
+  # The publishable macro can limit what actions are accessible to the
+  # publishable object
+  #
+  # @example provides default class methods
+  #   publishable
+  #
+  # @example only add the `.publish` method
+  #   publishable only: %i(publish)
+  #
+  # @example only add the `.unpublish`& `#unpublish` methods
+  #   publishable only: %i(unpublish)
+  #
+  using Sanity::Refinements::Strings
+
+  module Publishable
+    class << self
+      def included(base)
+        base.extend(ClassMethods)
+      end
+    end
+
+    module ClassMethods
+      PUBLISHABLE_ACTIONS = %i[publish unpublish].freeze
+
+      private
+
+      def publishable(**options)
+        options.fetch(:only, PUBLISHABLE_ACTIONS).each do |action|
+          if PUBLISHABLE_ACTIONS.include? action.to_sym
+            define_singleton_method(action) do |args|
+              Module.const_get("Sanity::Http::#{action.to_s.classify}").call(args)
+            end
+          end
+
+          if PUBLISHABLE_ACTIONS.include? action.to_sym
+            define_method(action) do
+              Module.const_get("Sanity::Http::#{action.to_s.classify}").call(attributes["_id"])
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/sanity/queryable.rb

@@ -36,15 +36,20 @@ module Sanity
 
       private
 
-      # @private
       def queryable(**options)
         options.fetch(:only, DEFAULT_KLASS_QUERIES).each do |query|
-          define_singleton_method(query) do |**args|
-            Module.const_get("Sanity::Http::#{query.to_s.classify}").call(**args.merge(resource_klass: self))
-          end
-          define_singleton_method("#{query}_api_endpoint") { QUERY_ENDPOINTS[query] }
+          define_query_method(query)
         end
       end
+
+      def define_query_method(query)
+        define_singleton_method(query) do |**args|
+          default_type = args.key?(:_type) ? args[:_type] : Sanity::TypeHelper.default_type(self)
+          default_args = {resource_klass: self, _type: default_type}.compact
+          Module.const_get("Sanity::Http::#{query.to_s.classify}").call(**default_args.merge(args))
+        end
+        define_singleton_method(:"#{query}_api_endpoint") { QUERY_ENDPOINTS[query] }
+      end
     end
   end
 end

data/lib/sanity/resource.rb

@@ -5,7 +5,6 @@ module Sanity
   # the sanity resources defined within this gem.
   #
   # Out of the box it includes the following mixins:
-  #   Sanity::Attributable
   #   Sanity::Mutatable
   #   Sanity::Queryable
   #   Sanity::Serializable
@@ -24,9 +23,13 @@ module Sanity
   #   end
   #
   class Resource
-    include Sanity::Attributable
+    include ActiveModel::Model
+    include ActiveModel::Attributes
+
     include Sanity::Mutatable
     include Sanity::Queryable
+    include Sanity::Publishable
+
     include Sanity::Serializable
   end
 end

data/lib/sanity/resources/document.rb

@@ -21,5 +21,6 @@ module Sanity
     # See https://www.sanity.io/docs/http-mutations#ac77879076d4
     mutatable api_endpoint: "data/mutate"
     queryable
+    publishable
   end
 end

data/lib/sanity/serializable.rb

@@ -50,8 +50,9 @@ module Sanity
 
       def class_serializer
         @class_serializer ||= proc do |results|
-          results["result"].map do |result|
-            attributes = result.slice(*self.attributes.map(&:to_s))
+          key = results.key?("result") ? "result" : "documents"
+          results[key].map do |result|
+            attributes = result.slice(*attribute_names)
             new(**attributes.transform_keys(&:to_sym))
           end
         end

data/lib/sanity/version.rb

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

data/lib/sanity.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require "active_model"
 require "forwardable"
 require "sanity/refinements"
 
@@ -8,11 +9,12 @@ require "sanity/configuration"
 
 require "sanity/groqify"
 require "sanity/http"
+require "sanity/helpers"
 
-require "sanity/attributable"
 require "sanity/mutatable"
 require "sanity/queryable"
 require "sanity/serializable"
+require "sanity/publishable"
 
 require "sanity/resource"
 require "sanity/resources"

data/sanity.gemspec

@@ -5,12 +5,12 @@ require_relative "lib/sanity/version"
 Gem::Specification.new do |spec|
   spec.name = "sanity-ruby"
   spec.version = Sanity::VERSION
-  spec.authors = "Morning Brew"
-  spec.email = "tech@morningbrew.com"
+  spec.authors = "Drew Monroe"
+  spec.email = "drew@pinecreeklabs.com"
 
   spec.summary = "Ruby bindings for the Sanity API"
   spec.description = ""
-  spec.homepage = "https://github.com/morning-brew/sanity-ruby"
+  spec.homepage = "https://github.com/dvmonroe/sanity-ruby"
   spec.license = "MIT"
   spec.required_ruby_version = Gem::Requirement.new(">= 2.6.0")
 
@@ -26,4 +26,6 @@ Gem::Specification.new do |spec|
   spec.bindir = "exe"
   spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
+
+  spec.add_dependency "activemodel"
 end

metadata

@@ -1,17 +1,31 @@
 --- !ruby/object:Gem::Specification
 name: sanity-ruby
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.5.0
 platform: ruby
 authors:
-- Morning Brew
+- Drew Monroe
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-10-23 00:00:00.000000000 Z
-dependencies: []
+date: 2024-04-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  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: ''
-email: tech@morningbrew.com
+email: drew@pinecreeklabs.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -42,6 +56,8 @@ files:
 - lib/sanity/groq/select.rb
 - lib/sanity/groq/slice.rb
 - lib/sanity/groqify.rb
+- lib/sanity/helpers.rb
+- lib/sanity/helpers/type_helper.rb
 - lib/sanity/http.rb
 - lib/sanity/http/create.rb
 - lib/sanity/http/create_if_not_exists.rb
@@ -50,10 +66,14 @@ files:
 - lib/sanity/http/find.rb
 - lib/sanity/http/mutation.rb
 - lib/sanity/http/patch.rb
+- lib/sanity/http/publication.rb
+- lib/sanity/http/publish.rb
 - lib/sanity/http/query.rb
 - lib/sanity/http/results.rb
+- lib/sanity/http/unpublish.rb
 - lib/sanity/http/where.rb
 - lib/sanity/mutatable.rb
+- lib/sanity/publishable.rb
 - lib/sanity/queryable.rb
 - lib/sanity/refinements.rb
 - lib/sanity/refinements/arrays.rb
@@ -66,13 +86,13 @@ files:
 - lib/sanity/serializable.rb
 - lib/sanity/version.rb
 - sanity.gemspec
-homepage: https://github.com/morning-brew/sanity-ruby
+homepage: https://github.com/dvmonroe/sanity-ruby
 licenses:
 - MIT
 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
+  homepage_uri: https://github.com/dvmonroe/sanity-ruby
+  source_code_uri: https://github.com/dvmonroe/sanity-ruby
+  changelog_uri: https://github.com/dvmonroe/sanity-ruby
 post_install_message:
 rdoc_options: []
 require_paths: