strapi 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2fb69f8122cef08e5397ed248b28d6cadaec1f9bd957324d94741dc674515111
+  data.tar.gz: 148174f62efc4a4566cbe6b96982f8a9981d37dba5b6e875ce17146308c7a3c5
+SHA512:
+  metadata.gz: cea0d86d27e200156e9f08ab505e32bd576ac6977de4965df0393e3106a92d549185577f580fc8a6b6d414ce4c1a1883496b3ec05b2a2776921b674768b8c759
+  data.tar.gz: f16548cd8666e6d8e9ee9f31f16c1d1dadf93d06a8c05e09397553ac9246b962503aabba2b8480a67f360b65275b4638e9d23b12c52c717d82c472fe0151e5af

data/.rubocop.yml

@@ -0,0 +1,4 @@
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 2.7
+  SuggestExtensions: false

data/Gemfile

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'debug', '~> 1.4'
+gem 'minitest', '~> 5.0'
+gem 'rake', '~> 13.0'
+gem 'rubocop', '~> 1.21'
+gem 'webmock', '~> 3.14'

data/Gemfile.lock

@@ -0,0 +1,98 @@
+PATH
+  remote: .
+  specs:
+    strapi (0.0.1)
+      activesupport (>= 5.0)
+      faraday (>= 1.0)
+      oj (>= 3.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (7.0.0)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    addressable (2.8.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    ast (2.4.2)
+    concurrent-ruby (1.1.9)
+    crack (0.4.5)
+      rexml
+    debug (1.4.0)
+      irb (>= 1.3.6)
+      reline (>= 0.2.7)
+    faraday (1.8.0)
+      faraday-em_http (~> 1.0)
+      faraday-em_synchrony (~> 1.0)
+      faraday-excon (~> 1.1)
+      faraday-httpclient (~> 1.0.1)
+      faraday-net_http (~> 1.0)
+      faraday-net_http_persistent (~> 1.1)
+      faraday-patron (~> 1.0)
+      faraday-rack (~> 1.0)
+      multipart-post (>= 1.2, < 3)
+      ruby2_keywords (>= 0.0.4)
+    faraday-em_http (1.0.0)
+    faraday-em_synchrony (1.0.0)
+    faraday-excon (1.1.0)
+    faraday-httpclient (1.0.1)
+    faraday-net_http (1.0.1)
+    faraday-net_http_persistent (1.2.0)
+    faraday-patron (1.0.0)
+    faraday-rack (1.0.0)
+    hashdiff (1.0.1)
+    i18n (1.8.11)
+      concurrent-ruby (~> 1.0)
+    io-console (0.5.11)
+    irb (1.4.1)
+      reline (>= 0.3.0)
+    minitest (5.15.0)
+    multipart-post (2.1.1)
+    oj (3.13.10)
+    parallel (1.21.0)
+    parser (3.0.3.2)
+      ast (~> 2.4.1)
+    public_suffix (4.0.6)
+    rainbow (3.0.0)
+    rake (13.0.6)
+    regexp_parser (2.2.0)
+    reline (0.3.1)
+      io-console (~> 0.5)
+    rexml (3.2.5)
+    rubocop (1.24.1)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.15.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.15.1)
+      parser (>= 3.0.1.1)
+    ruby-progressbar (1.11.0)
+    ruby2_keywords (0.0.5)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.1.0)
+    webmock (3.14.0)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  arm64-darwin-21
+  x86_64-linux
+
+DEPENDENCIES
+  debug (~> 1.4)
+  minitest (~> 5.0)
+  rake (~> 13.0)
+  rubocop (~> 1.21)
+  strapi!
+  webmock (~> 3.14)
+
+BUNDLED WITH
+   2.2.32

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 justin talbott
+
+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,140 @@
+# Strapi
+
+[Strapi](https://strapi.io) is an Open source Node.js Headless CMS to easily build customizable
+APIs. It’s great for quickly building your data layer alongside a UI to manage it.
+
+Say you (like me) like to quickly build sites and applications in Ruby and/or/on Rails. The goal of
+the Strapi gem is to make it just as easy to define Ruby classes that represent and interact with
+your Strapi content types as it is to define them within Strapi itself.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'strapi', github: 'waymondo/strapi-ruby'
+```
+
+And then execute:
+
+    $ bundle install
+
+This gem has only been tested with Strapi v4. It may work with previous versions of Strapi, but they
+remain untested.
+
+## Usage
+
+### Configuration
+
+You will first need to set an `ENV` variable for `STRAPI_HOST_URL` and `STRAPI_API_TOKEN` (the
+  latter is only required if accessing content types requires authentication). This can be done with
+  [`dotenv`](https://github.com/bkeepers/dotenv/), in an initializer, or some other mechanism.
+
+If using `dotev`, your `.env` file would contain:
+
+```
+STRAPI_HOST_URL=http://localhost:1337
+STRAPI_API_TOKEN=asdf1234qwer5678
+```
+
+#### Defining Content Type Classes
+
+In Ruby, define some content type classes, i.e.:
+
+``` ruby
+class Farm < Strapi::ContentType
+  field :name
+  field :cows, content_type: 'Cow'
+  field :photo, content_type: 'Strapi::Media'
+end
+```
+
+``` ruby
+class Cow < Strapi::ContentType
+  field :name
+  field :farm, content_type: 'Farm'
+end
+```
+
+Using the `field` class method will define getter and setter methods for the class objects. If you
+supply a class name to the `content_type` option, it will transform it to an instance of that class
+when using the getter method. This works for both one-to-one and one-to-many relations:
+
+``` ruby
+cow.name # => "Hershey"
+cow.farm # => #<Farm>
+farm.name # => "McDonald’s"
+farm.cows # => [#<Cow>, #<Cow>]
+```
+
+In keeping with ruby conventions, attribute keys returned from your Strapi API will be underscored,
+so if you have an attribute of `"colorPattern": "jersey"` in your JSON, your field definition should
+be `field :color_pattern`.
+
+[`Strapi::Media`](https://github.com/waymondo/strapi-ruby/blob/main/lib/strapi/media.rb) is an
+included content type class to represent photos, videos, and files. Feel free to extend this class
+if you would like to add additional functionality or granularity.
+
+``` ruby
+farm.photo # => #<Strapi::Media>
+farm.photo.url # => "http://localhost:1337/uploads/farm-1.jpg"
+```
+
+By default, `Strapi::ContentType` will infer it’s API plural id from the demodulized, dasherized,
+pluralized name of the ruby class. For example, it would assume a class of `FarmWorker` would have a
+Strapi plural ID of `farm-workers`. If you would like to customize this, you can set it in the class
+definition:
+
+``` ruby
+class FarmWorker
+  plural_id 'farmers'
+end
+```
+
+### Fetching Entries
+
+`Strapi::ContentType` provides some predictable methods for retrieving entries from your Strapi API:
+
+``` ruby
+Cow.all # => [#<Cow>, #<Cow>, #<Cow>]
+cow = Cow.find(1)
+cow.id # => 1
+```
+
+Both `.all` and `.find` accept a hash of options that map to Strapi’s allowed [API
+parameters](https://docs.strapi.io/developer-docs/latest/developer-resources/database-apis-reference/rest-api.html). No
+parameter options are included by default, so if you want to eagerly load related content types for
+example, you’ll need to specify that with the `populate` option:
+
+``` ruby
+cows = Cow.all(populate: "*")
+cows.first.farm.name # => "McDonald’s"
+farm = Farm.find(1, populate: ['cows'])
+farm.cows.first.name # => "Hershey"
+```
+
+The class method `.where` also exists, which is the same implementation as `.all`, except a hash of
+API parameters is required.
+
+### CRUD
+
+Coming Soon
+
+## 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 the created tag, 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/waymondo/strapi.
+
+## 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,17 @@
+# frozen_string_literal: true
+
+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']
+  t.warning = false
+end
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'strapi'
+
+# 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
+
+require 'irb'
+IRB.start(__FILE__)

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/lib/strapi/connection.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Strapi
+  # The singleton class representing the Faraday connection to Strapi
+  class Connection
+    class << self
+      def instance
+        @instance ||= Faraday::Connection.new("#{ENV['STRAPI_HOST_URL']}/api", options)
+      end
+
+      def options
+        return unless (api_token = ENV['STRAPI_API_TOKEN'].presence)
+
+        {
+          headers: {
+            'Authorization' => "bearer #{api_token}"
+          }
+        }
+      end
+    end
+  end
+end

data/lib/strapi/content_type.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+module Strapi
+  # The class for defining a Ruby class that represents a Strapi Content-Type
+  class ContentType
+    attr_reader :id, :attributes
+
+    def initialize(response_data)
+      @id = response_data['id']
+      @attributes = response_data['attributes'].transform_keys(&:underscore)
+    end
+
+    def created_at
+      datetime_from_timestamp 'created_at'
+    end
+
+    def updated_at
+      datetime_from_timestamp 'updated_at'
+    end
+
+    def published_at
+      datetime_from_timestamp 'published_at'
+    end
+
+    def ==(other)
+      other.is_a?(self.class) && id == other.id
+    end
+
+    private
+
+    def datetime_from_timestamp(key)
+      return unless (timestamp = @attributes[key])
+
+      DateTime.parse timestamp
+    end
+
+    def strapi_attr_value(attr, options)
+      value = @attributes[attr.to_s]
+      return value unless (content_type = options[:content_type])
+
+      content_type_class = content_type.is_a?(String) ? content_type.constantize : content_type
+      if (data = value['data']).is_a?(Array)
+        data.map do |entry|
+          content_type_class.new(entry)
+        end
+      else
+        content_type_class.new(data)
+      end
+    end
+
+    class << self
+      def plural_id(name)
+        @_plural_id = name
+      end
+
+      def field(attr, options = {})
+        define_method attr do
+          strapi_attr_value(attr, options)
+        end
+
+        define_method "#{attr}=" do |value|
+          attributes[attr.to_s] = value
+        end
+      end
+
+      def find(id, query_hash = {})
+        new Request.get("#{_plural_id}/#{id}?#{query_hash.to_query}").data
+      end
+
+      def all(query_hash = {})
+        get_list(query_hash)
+      end
+
+      def where(query_hash)
+        get_list(query_hash)
+      end
+
+      private
+
+      def get_list(query_hash)
+        strapi_filter_query(query_hash).map do |result|
+          new result
+        end
+      end
+
+      def strapi_filter_query(query_hash)
+        Request.get("#{_plural_id}?#{query_hash.to_query}").data
+      end
+
+      def _plural_id
+        @_plural_id ||= to_s.demodulize.tableize.dasherize
+      end
+    end
+  end
+end

data/lib/strapi/error.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Strapi
+  # An error raised within the Strapi ruby library
+  class Error < StandardError
+    attr_reader :status, :name, :message, :details
+
+    def initialize(hash = {})
+      super
+      @status = hash['status']
+      @name = hash['name']
+      @message = hash['message']
+      @details = hash['details']
+    end
+  end
+end

data/lib/strapi/media.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Strapi
+  # The Content-Type for uploaded Strapi photos, videos, and files
+  class Media < ContentType
+    field :name
+    field :alternative_text
+    field :caption
+    field :width
+    field :height
+    field :formats # TODO: attribute value
+    field :hash
+    field :ext
+    field :mime
+    field :size
+    field :url
+    field :preview_url
+    field :preview_provider
+    field :provider_metadata
+
+    def url
+      ENV['STRAPI_HOST_URL'] + @attributes['url']
+    end
+  end
+end

data/lib/strapi/request.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Strapi
+  # A convenience wrapper around Faraday to make a request to the Strapi API
+  class Request
+    class << self
+      %i[get head delete trace post put patch].each do |method|
+        define_method(method) do |*args|
+          Response.new(Connection.instance.send(method, *args))
+        end
+      end
+    end
+  end
+end

data/lib/strapi/response.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Strapi
+  # The parsed response returned from the Strapi API
+  class Response
+    attr_reader :parsed_response
+
+    def initialize(faraday_response)
+      @parsed_response = Oj.load(faraday_response.body)
+      puts '########################'
+      p @parsed_response
+      puts '########################'
+      return if faraday_response.success?
+
+      raise Error, error
+    end
+
+    %w[data error].each do |method|
+      define_method(method) do
+        @parsed_response[method]
+      end
+    end
+  end
+end

data/lib/strapi/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Strapi
+  VERSION = '0.0.1'
+end

data/lib/strapi.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'active_support'
+require 'active_support/core_ext/string/inflections'
+require 'active_support/core_ext/object/to_query'
+require 'faraday'
+require 'oj'
+
+require_relative 'strapi/connection'
+require_relative 'strapi/content_type'
+require_relative 'strapi/error'
+require_relative 'strapi/media'
+require_relative 'strapi/request'
+require_relative 'strapi/response'
+require_relative 'strapi/version'

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: strapi
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- justin talbott
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-01-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: oj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Easily define Strapi content as Ruby classes
+email:
+- gmail@justintalbott.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/strapi.rb
+- lib/strapi/connection.rb
+- lib/strapi/content_type.rb
+- lib/strapi/error.rb
+- lib/strapi/media.rb
+- lib/strapi/request.rb
+- lib/strapi/response.rb
+- lib/strapi/version.rb
+homepage: https://github.com/waymondo/strapi
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/waymondo/strapi
+  source_code_uri: https://github.com/waymondo/strapi
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.32
+signing_key:
+specification_version: 4
+summary: Easily define Strapi content as Ruby classes
+test_files: []