sanity-ruby 0.4.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e02c772808fc5112f526e0e8bd329a829dd4ba0e2395d82a83d34f8419a05e66
-  data.tar.gz: c2b80c8bee2242e68ec2b814fc18e11ad699687a2174889cdf4a7b34823405f2
+  metadata.gz: 8cb8ebee529e3f7aa924f79ef9db8971f2e02ff727f307a0af4c2e01cd778afc
+  data.tar.gz: ac53d38a057a8e830ccfed73032d751bdf3f49f98e70b835b7d4b108a31ef2a3
 SHA512:
-  metadata.gz: e265993399cfa3c24f821cac9625daaf763a0468353d18f0fac375231bc9e62e727f2a3314bbf55fc7aaa3b5d51f733822cc16409489bf6f3aebbff75ba5c72d
-  data.tar.gz: 5bf5fbfdb1fcf02d691fec0ad2226d2c24a9b993559f6e92eba16d6961eb0f54d97c70616e6642f6f42982666f3e3443b98bc8a9c53dc356b6fa956e99ae077b
+  metadata.gz: c613cd3d0dc68006d80f0a52b40a2884d654e77357e516b30e01ff78519360ca592fa8ea0c06962792daad9aac7d9841d83a7ee11c8c73d07c588e75730a87ae
+  data.tar.gz: 799a99a83a17e76526efa652207f1aad6756c01574a2dd63b786c9a3af75192ca5c6b10ca2ffaba602d275fdbf9ef7ee38996af258364406ca5b7a6818ef3855

data/.github/workflows/ci.yml

@@ -6,7 +6,7 @@ jobs:
     strategy:
       matrix:
         # Due to https://github.com/actions/runner/issues/849, we have to use quotes for '3.0'
-        ruby: [2.6, 2.7, "3.0"]
+        ruby: [2.6, 2.7, "3.0", "3.3"]
     steps:
       - uses: actions/checkout@v2
       - uses: ruby/setup-ruby@v1

data/Dockerfile-3.3

@@ -0,0 +1,30 @@
+FROM ruby:3.3-alpine as base
+
+RUN apk add --update --no-cache \
+  build-base \
+  cmake \
+  tzdata \
+  bash \
+  git
+
+ENV APP_PATH /var/www/sanity-ruby
+RUN mkdir -p $APP_PATH
+
+# Build intermediate
+FROM base as intermediate
+
+WORKDIR $APP_PATH
+
+RUN rm -rf /var/cache/apk/*
+
+FROM base as development
+
+COPY --from=intermediate $APP_PATH $APP_PATH
+
+WORKDIR $APP_PATH
+
+ENV GEM_HOME $APP_PATH/vendor/bundle
+ENV BUNDLE_PATH vendor/bundle
+
+COPY . ./
+RUN bundle check || bundle install

data/README.md

@@ -35,6 +35,52 @@ gem 'sanity-ruby'
 Setup your configuration. If using in Rails, consider setting this in an initializer:
 
 ```ruby
+# config/initializers/sanity.rb
+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
+
+# OR
+
+# Sanity.configure do |s|
+#   s.token = ENV.fetch("SANITY_TOKEN", "")
+#   s.api_version = ENV.fetch("SANITY_API_VERSION", "")
+#   s.project_id = ENV.fetch("SANITY_PROJECT_ID", "")
+#   s.dataset = ENV.fetch("SANITY_DATASET", "")
+#   s.use_cdn = ENV.fetch("SANITY_USE_CDN", false)
+# end
+```
+
+or you can set the following ENV variables at runtime without any initializer:
+
+```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 by default meaning you can connect to multiple different projects and/or API variations across any number of threads. A real world scenario when working with Sanity may require that you sometimes interact with the [CDN based API](https://www.sanity.io/docs/api-cdn) and sometimes the non-CDN based API. Using ENV variables combined with the thread safe configuration object gives you the ultimate flexibility.
+
+If you're using this gem in a Rails application AND you're interacting with only ONE set of configuration you can make the gem use the global configuration by setting the `use_global_config` option to `true`.
+
+Your initializer `config/initializers/sanity.rb` should look like:
+
+```ruby
+# `use_global_config` is NOT thread safe. DO NOT use if you intend on changing the
+# config object at anytime within your application's lifecycle.
+#
+# Do not use `use_global_config` in your application if you're:
+# - Interacting with various Sanity project ids/token
+# - Interacting with multiple API versions
+# - Interacting with calls that sometimes require the use of the CDN and sometimes don't
+
+Sanity.use_global_config = true
 Sanity.configure do |s|
   s.token = "yoursupersecrettoken"
   s.api_version = "v2021-03-25"
@@ -70,12 +116,15 @@ 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`.
@@ -204,6 +253,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):

data/bin/dev-lint

@@ -1,3 +1,6 @@
 #!/usr/bin/env ruby
 
-system "docker-compose run --rm 2.6 bin/standardrb && docker-compose run --rm 2.7 bin/standardrb && docker-compose run --rm 3.0 bin/standardrb"
+system "docker-compose run --rm 2.6 bin/standardrb && \
+        docker-compose run --rm 2.7 bin/standardrb && \
+        docker-compose run --rm 3.0 bin/standardrb && \
+        docker-compose run --rm 3.3 bin/standardrb"

data/bin/dev-test

@@ -1,3 +1,6 @@
 #!/usr/bin/env ruby
 
-system "docker-compose run --rm 2.6 bundle exec rake test && docker-compose run --rm 2.7 bundle exec rake test && docker-compose run --rm 3.0 bundle exec rake test"
+system "docker-compose run --rm 2.6 bundle exec rake test && \
+        docker-compose run --rm 2.7 bundle exec rake test && \
+        docker-compose run --rm 3.0 bundle exec rake test && \
+        docker-compose run --rm 3.3 bundle exec rake test"

data/docker-compose.yml

@@ -1,5 +1,3 @@
-version: '3.9'
-
 services:
   '2.6':
     build:
@@ -40,6 +38,19 @@ services:
     container_name: sanity-ruby-3.0
     command: bash
 
+  '3.3':
+    build:
+      context: .
+      dockerfile: Dockerfile-3.3
+    tty: true
+    stdin_open: true
+    volumes:
+      - ./bin:/var/www/sanity-ruby/bin/
+      - ./lib:/var/www/sanity-ruby/lib/
+      - ./test:/var/www/sanity-ruby/test/
+    container_name: sanity-ruby-3.3
+    command: bash  
+
 volumes:
   bin:
   lib:

data/lib/sanity/configuration.rb

@@ -18,32 +18,47 @@ 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
     def api_subdomain
       use_cdn ? "apicdn" : "api"
     end
-  end
 
-  def self.configuration
-    @configuration ||= Configuration.new
+    def to_h
+      instance_variables.each_with_object({}) do |var, obj|
+        obj[var.to_s.delete("@").to_sym] = instance_variable_get(var)
+      end
+    end
   end
 
   class << self
+    attr_accessor :use_global_config
+
+    def configuration
+      if use_global_config
+        @configuration ||= Configuration.new
+      else
+        Thread.current[:sanity_configuration] ||= Configuration.new
+      end
+    end
     alias_method :config, :configuration
-  end
 
-  def self.configuration=(config)
-    @configuration = config
-  end
+    def configuration=(config)
+      if use_global_config
+        @configuration = config
+      else
+        Thread.current[:sanity_configuration] = config
+      end
+    end
 
-  def self.configure
-    yield configuration
+    def configure
+      yield configuration
+    end
   end
 end

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/resource.rb

@@ -28,6 +28,8 @@ module Sanity
 
     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/version.rb

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

data/lib/sanity.rb

@@ -14,6 +14,7 @@ require "sanity/helpers"
 require "sanity/mutatable"
 require "sanity/queryable"
 require "sanity/serializable"
+require "sanity/publishable"
 
 require "sanity/resource"
 require "sanity/resources"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sanity-ruby
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Drew Monroe
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-02-25 00:00:00.000000000 Z
+date: 2024-08-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -37,6 +37,7 @@ files:
 - Dockerfile-2.6
 - Dockerfile-2.7
 - Dockerfile-3.0
+- Dockerfile-3.3
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -66,10 +67,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
@@ -89,7 +94,7 @@ metadata:
   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:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -104,8 +109,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.17
-signing_key:
+rubygems_version: 3.0.3.1
+signing_key: 
 specification_version: 4
 summary: Ruby bindings for the Sanity API
 test_files: []