sanity-ruby 0.1.0

checksums.yaml

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

data/.github/workflows/ci.yml

@@ -0,0 +1,29 @@
+name: ci
+on: push
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    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"]
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - run: bundle exec rake test
+
+  lint:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: [2.6]
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - run: bundle exec rake lint

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+Gemfile.lock

data/.standard.yml

@@ -0,0 +1,2 @@
+parallel: true
+format: progress

data/Gemfile

@@ -0,0 +1,16 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in sanity.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "minitest", "~> 5.0"
+gem "minitest-reporters", ">= 1.4"
+gem "mocha", ">= 1.12"
+gem "pry"
+
+gem "guard"
+gem "guard-minitest"
+gem "yard"
+
+gem "standard"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Drew Monroe
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,203 @@
+# 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>
+
+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 library also provides other features. For example:
+
+  - 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)
+
+## Getting Started
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sanity-ruby'
+```
+
+To create a new document:
+
+```ruby
+Sanity::Document.create(params: {_type: "user", first_name: "Carl", last_name: "Sagan"})
+```
+
+To create a new asset:
+
+```ruby
+# TODO
+```
+
+To make any PORO a sanity resource:
+
+```ruby
+class User < Sanity::Resource
+  attribute :_id, default: ""
+  attribute :_type: default: ""
+  mutatable only: %i(create delete)
+  queryable
+end
+```
+
+To create a new document in Sanity:
+
+```ruby
+User.create(params: { first_name: "Carl", last_name: "Sagan" })
+```
+
+or if you need to validate the object in your application first:
+
+```ruby
+user = User.new(first_name: "Carl", last_name: "Sagan")
+# your business logic here...
+user.create
+```
+
+To make any PORO act like a sanity resource:
+
+```ruby
+class User
+  include Sanity::Mutatable
+  include Sanity::Queryable
+  queryable
+  mutatable
+end
+```
+
+## Mutating
+
+To [create a document](https://www.sanity.io/docs/http-mutations#c732f27330a4):
+
+```ruby
+Sanity::Document.create(params: {_type: "user", first_name: "Carl", last_name: "Sagan"})
+```
+
+To [create or replace a document](https://www.sanity.io/docs/http-mutations#95bb692d7fb0):
+
+```ruby
+Sanity::Document.create_or_replace(params: { _id: "1234-321", _type: "user", first_name: "Carl", last_name: "Sagan"})
+```
+
+To [create a document if it does not exist](https://www.sanity.io/docs/http-mutations#bd91661cae0c):
+
+```ruby
+Sanity::Document.create_if_not_exists(params: { _id: "1234-321", _type: "user", first_name: "Carl", last_name: "Sagan"})
+```
+
+To [delete a document](https://www.sanity.io/docs/http-mutations#40a9a879af9b):
+
+```ruby
+Sanity::Document.delete(params: { _id: "1234-321"})
+```
+
+To [patch a document](https://www.sanity.io/docs/http-mutations#2f480b2baca5):
+
+```ruby
+Sanity::Document.patch(params: { _id: "1234-321", set: { first_name: "Carl" }})
+```
+
+## Querying
+
+To [find document(s) by id](https://www.sanity.io/docs/http-doc):
+
+```ruby
+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_
+
+```ruby
+where: {
+  _id: "123", # _id == '123'
+  _id: {not: "123"} # _id != '123'
+  title: {match: "wo*"} # title match 'wo*'
+  popularity: {gt: 10}, # popularity > 10
+  popularity: {gt_eq: 10}, # popularity >= 10
+  popularity: {lt: 10}, # popularity < 10
+  popularity: {lt_eq: 10}, # popularity <= 10
+  _type: "movie", or: {_type: "cast"} # _type == 'movie' || _type == 'cast'
+  _type: "movie", and: {or: [{_type: "cast"}, {_type: "person"}]} # _type == 'movie' && (_type == 'cast' || _type == 'person')
+  _type: "movie", or: [{_type: "cast"}, {_type: "person"}] # _type == 'movie' || _type == 'cast' || _type == 'person'
+}
+```
+
+```ruby
+Sanity::Document.where(_type: "user", and: {or: {_id:  "123", first_name: "Carl" }})
+# Resulting GROQ:
+# *[_type == 'user' && (_id == '123' || first_name == 'Carl')]
+```
+
+[Order](https://www.sanity.io/docs/query-cheat-sheet#b5aec96cf56c)
+
+_partially supported_
+
+```ruby
+order: { createdAt: :desc, updatedAt: :asc }
+# order(createdAt desc) | order(updatedAt asc)
+```
+
+[Limit](https://www.sanity.io/docs/query-cheat-sheet#170b92d4caa2)
+
+```ruby
+limit: 5, offset: 10
+```
+
+```ruby
+Sanity::Document.where(_type: "user", limit: 5, offset: 2)
+```
+
+[Select](https://www.sanity.io/docs/query-cheat-sheet#55d30f6804cc)
+
+_partially supported_
+
+```ruby
+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}}}")
+```
+
+## 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).
+
+## 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/Rakefile

@@ -0,0 +1,24 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task default: :test
+
+##
+# Github Actions always sets ENV["CI"] to true, so we can depend on it to prevent
+# standardrb from running with the "--fix" flag.
+#
+# @see
+#   https://docs.github.com/en/actions/reference/environment-variables#default-environment-variables
+task :lint do
+  if ENV["CI"]
+    sh "bin/standardrb"
+  else
+    sh "bin/standardrb --fix"
+  end
+end

data/bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "sanity"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+require "pry"
+Pry.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/bin/standardrb

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'standardrb' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if /This file was generated by Bundler/.match?(File.read(bundle_binstub, 300))
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("standard", "standardrb")

data/lib/sanity.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require "forwardable"
+require "sanity/refinements"
+
+require "sanity/version"
+require "sanity/configuration"
+
+require "sanity/groqify"
+require "sanity/http"
+
+require "sanity/attributable"
+require "sanity/mutatable"
+require "sanity/queryable"
+
+require "sanity/resource"
+require "sanity/resources"
+
+module Sanity
+  class Error < StandardError; end
+end

data/lib/sanity/attributable.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module Sanity
+  # Attributable is responsible for setting the appropriate attributes
+  # on an object in memory
+  #
+  # The attribute marco is used to define the available attributes and
+  # the default return value if applicable
+  #
+  # @example provides getter and setter methods for `_id` and sets the default value to an empty string
+  #   attribute :_id, default: ""
+  #
+  module Attributable
+    class << self
+      def included(base)
+        base.extend(ClassMethods)
+      end
+    end
+
+    module ClassMethods
+      def attributes
+        @attributes ||= []
+      end
+
+      def default_attributes
+        @defaults ||= {}
+      end
+
+      private
+
+      def attribute(name, default: nil)
+        attributes << name
+        default_attributes.merge!("#{name}": default)
+      end
+    end
+
+    attr_reader :attributes
+
+    def initialize(**args)
+      self.class.default_attributes.merge(args).then do |attrs|
+        attrs.each do |key, val|
+          define_singleton_method("#{key}=") do |val|
+            args[key] = val
+            attributes[key] = val
+          end
+
+          define_singleton_method(key) { args[key] }
+        end
+
+        instance_variable_set("@attributes", attrs)
+      end
+    end
+
+    def inspect
+      attributes.keys.map { |key| "#{key}: #{attributes[key].inspect}" }.join(", ").then do |attrs|
+        attrs.empty? ? "#<#{_instance}>" : "#<#{_instance} #{attrs}>"
+      end
+    end
+
+    private
+
+    def _instance
+      "#{self.class}:0x#{object_id}"
+    end
+  end
+end