strapi 0.0.3 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1008e166d6c268ae6444d920af7a31d994be6e130569882e084ad334738188f5
-  data.tar.gz: 4291af805a8ebcb38444060c9a9bff7adef39a128940ea93f8065d7325206370
+  metadata.gz: d53922d37bd74ca71fe212f659e11eae7ad4e234ff13d97086dfb726a5a1cf04
+  data.tar.gz: d5364ee3614d54b78b594111add3095672372a152b3ecdccfd8a5c2294dc05bc
 SHA512:
-  metadata.gz: d766fba9e67d4bce68928c953fbb199ceb8a626d101938d863b4d4bc8260254e448da1b7c80db8c8b8a400a34743ca83681bb065577e3688cab3bc620729395a
-  data.tar.gz: 9c9be3da48c59cd82263a8c3bfbc105b5074a1a041f0f76d68343137b1ecc15220e15f85e3d1b4523f9f2ba0eddac001f664c23644e7f8f91fada00f767e7208
+  metadata.gz: cde55210154b089606d519332a6b67dc8d9e06c9b2b656e582ebe60c19bf0d7694c4d7a8fc1b22ffb935af26bf6f8f9ca120f7a9a04f5a226efd1a61eefccba8
+  data.tar.gz: 816131f378cb4b7ea3855e6c51b78d62c84e7c597281449f23b66594781d6e1c02792dc23ddd63d87a5d7aad47aab7bf99d0295f21e81f0fed3d3ccab6401e06

data/Gemfile.lock

@@ -1,16 +1,15 @@
 PATH
   remote: .
   specs:
-    strapi (0.0.3)
+    strapi (0.0.4)
       activesupport
       faraday (~> 2.0)
       faraday-net_http (~> 2.0)
-      oj (~> 3.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.0.0)
+    activesupport (7.0.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
@@ -24,10 +23,10 @@ GEM
     debug (1.4.0)
       irb (>= 1.3.6)
       reline (>= 0.2.7)
-    faraday (2.0.0)
+    faraday (2.0.1)
+      faraday-net_http (~> 2.0)
       ruby2_keywords (>= 0.0.4)
-    faraday-net_http (2.0.0)
-      faraday (~> 2.0)
+    faraday-net_http (2.0.1)
     hashdiff (1.0.1)
     i18n (1.8.11)
       concurrent-ruby (~> 1.0)
@@ -35,7 +34,6 @@ GEM
     irb (1.4.1)
       reline (>= 0.3.0)
     minitest (5.15.0)
-    oj (3.13.10)
     parallel (1.21.0)
     parser (3.0.3.2)
       ast (~> 2.4.1)

data/README.md

@@ -27,22 +27,30 @@ And then execute:
 
 ## Usage
 
-This gem has only been tested with Strapi v4. It may work with previous versions of Strapi, but they
+Note: this gem has only been tested with Strapi v4. It may work with previous versions of Strapi, but they
 remain untested at this time.
 
 ### 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.
+You will first need to set an `ENV` variable for `STRAPI_HOST_URL`, `STRAPI_IDENTIFIER` and
+`STRAPI_PASSWORD`. 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
+STRAPI_IDENTIFIER=admin@example.com
+STRAPI_PASSWORD=password
 ```
 
+The `STRAPI_IDENTIFIER` and `STRAPI_PASSWORD` should be the login information for a user with a role
+that grants access to your authenticated content. [Strapi Authenticated request
+documentation](https://docs.strapi.io/developer-docs/latest/guides/auth-request.html)
+
+Upon running the first method that interacts with the Strapi API, a JWT token will be fetched and
+cached.
+
 ### Defining Content Type Classes
 
 In Ruby, define some content type classes, i.e.:
@@ -122,6 +130,10 @@ 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.
 
+``` ruby
+cows = Cow.where(filters: { name: { '$eq': 'Hershey' } })
+```
+
 ### Creating, Updating, Deleting
 
 You can create and update entries by calling `.save` on them:

data/lib/strapi/connection.rb

@@ -5,28 +5,19 @@ module Strapi
   class Connection
     class << self
       def instance
-        @instance ||= build_instance
-      end
-
-      private
-
-      def build_instance
-        unless Faraday.default_adapter
-          require 'faraday/net_http'
-          Faraday.default_adapter = :net_http
+        @instance ||= Faraday::Connection.new("#{ENV['STRAPI_HOST_URL']}/api") do |f|
+          f.request :json
+          f.response :json
+          f.adapter :net_http
         end
-
-        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}"
-          }
-        }
+      def jwt_token
+        @jwt_token ||= instance.post(
+          'auth/local',
+          identifier: ENV['STRAPI_IDENTIFIER'],
+          password: ENV['STRAPI_PASSWORD']
+        ).body['jwt']
       end
     end
   end

data/lib/strapi/content_type.rb

@@ -19,10 +19,10 @@ module Strapi
       other.is_a?(self.class) && id == other.id
     end
 
-    def save(query_hash = {})
+    def save(params = {})
       return if deleted
 
-      response = id ? update_request(query_hash) : create_request(query_hash)
+      response = id ? update_request(params) : create_request(params)
       entry = self.class.send(:new_from_response, response)
       tap do
         @attributes = attributes.deep_merge entry.attributes
@@ -30,8 +30,8 @@ module Strapi
       end
     end
 
-    def delete(query_hash = {})
-      Request.delete("#{self.class.send(:_plural_id)}/#{id}?#{query_hash.to_query}")
+    def delete(params = {})
+      Request.delete("#{self.class.send(:_plural_id)}/#{id}", params)
       @attributes = {}
       @id = nil
       @deleted = true
@@ -40,16 +40,16 @@ module Strapi
 
     private
 
-    def create_request(query_hash)
+    def create_request(params)
       Request.post(
-        "#{self.class.send(:_plural_id)}?#{query_hash.to_query}",
+        "#{self.class.send(:_plural_id)}?#{params.to_query}",
         data: attributes.slice(*self.class.fields)
       ).data
     end
 
-    def update_request(query_hash)
+    def update_request(params)
       Request.put(
-        "#{self.class.send(:_plural_id)}/#{id}?#{query_hash.to_query}",
+        "#{self.class.send(:_plural_id)}/#{id}?#{params.to_query}",
         data: attributes.slice(*self.class.fields)
       ).data
     end
@@ -61,7 +61,7 @@ module Strapi
     end
 
     def strapi_attr_value(attr, options)
-      value = @attributes[attr]
+      return unless (value = @attributes[attr])
       return value unless (content_type = options[:content_type])
 
       content_type_class = content_type.is_a?(String) ? content_type.constantize : content_type
@@ -94,32 +94,34 @@ module Strapi
         end
       end
 
-      def find(id, query_hash = {})
-        new_from_response Request.get("#{_plural_id}/#{id}?#{query_hash.to_query}").data
+      def find(id, params = {})
+        new_from_response Request.get("#{_plural_id}/#{id}", params).data
       end
 
-      def all(query_hash = {})
-        get_list(query_hash)
+      def all(params = {})
+        get_list(params)
       end
 
-      def where(query_hash)
-        get_list(query_hash)
+      def where(params)
+        get_list(params)
       end
 
-      def create(attributes, query_hash = {})
-        new(attributes).save(query_hash)
+      def create(attributes, params = {})
+        new(attributes).save(params)
       end
 
       private
 
       def new_from_response(response)
+        return unless response
+
         new(response['attributes'].transform_keys(&:underscore)).tap do |entry|
           entry.instance_variable_set('@id', response['id'])
         end
       end
 
-      def get_list(query_hash)
-        Request.get("#{_plural_id}?#{query_hash.to_query}").data.map do |result|
+      def get_list(params)
+        Request.get(_plural_id, params).data.map do |result|
           new_from_response result
         end
       end

data/lib/strapi/media.rb

@@ -19,7 +19,13 @@ module Strapi
     field :provider_metadata
 
     def url
-      ENV['STRAPI_HOST_URL'] + @attributes['url']
+      return unless (url_string = @attributes[:url].presence)
+
+      if url_string.include?('//')
+        url_string
+      else
+        ENV['STRAPI_HOST_URL'] + url_string
+      end
     end
   end
 end

data/lib/strapi/request.rb

@@ -3,12 +3,35 @@
 module Strapi
   # A convenience wrapper around Faraday to make a request to the Strapi API
   class Request
+    ALLOWED_PARAM_KEYS = %i[sort filters populate fields pagination publicationState locale].freeze
+    REQUEST_VERBS_WITHOUT_BODIES = %i[get head delete trace].freeze
+
     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))
+        define_method(method) do |path, args = {}|
+          validate_query_params(args) if REQUEST_VERBS_WITHOUT_BODIES.include?(method)
+
+          Response.new(
+            Connection.instance.send(method, path, args) do |f|
+              f.headers = {
+                'Authorization' => "bearer #{Connection.jwt_token}"
+              }
+            end
+          )
         end
       end
+
+      private
+
+      def validate_query_params(params)
+        unallowed_query_params = params.keys - ALLOWED_PARAM_KEYS
+        return unless unallowed_query_params.size.positive?
+
+        raise(
+          Error,
+          'message' => "Unallowed query params - #{unallowed_query_params.join(', ')}"
+        )
+      end
     end
   end
 end

data/lib/strapi/response.rb

@@ -6,7 +6,7 @@ module Strapi
     attr_reader :parsed_response
 
     def initialize(faraday_response)
-      @parsed_response = Oj.load(faraday_response.body)
+      @parsed_response = faraday_response.body
       return if faraday_response.success?
 
       raise Error, error

data/lib/strapi/version.rb

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

data/lib/strapi.rb

@@ -5,7 +5,7 @@ require 'active_support/core_ext/string/inflections'
 require 'active_support/core_ext/object/to_query'
 require 'active_support/core_ext/hash/keys'
 require 'faraday'
-require 'oj'
+require 'faraday/net_http'
 
 require_relative 'strapi/connection'
 require_relative 'strapi/content_type'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: strapi
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
 platform: ruby
 authors:
 - justin talbott
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-01-05 00:00:00.000000000 Z
+date: 2022-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -52,20 +52,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.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:
 email:
 - gmail@justintalbott.com
@@ -111,7 +97,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.32
+rubygems_version: 3.3.3
 signing_key:
 specification_version: 4
 summary: Simple Ruby classes for Strapi content types