strapi 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2fb69f8122cef08e5397ed248b28d6cadaec1f9bd957324d94741dc674515111
-  data.tar.gz: 148174f62efc4a4566cbe6b96982f8a9981d37dba5b6e875ce17146308c7a3c5
+  metadata.gz: 01f0caddbedae31af4265a1c71c53cd2e637b6ebee6e4781f39fed76a198bb38
+  data.tar.gz: 97c263e1c894cd5b78beb8fba42f8949bf9276271ae8506f2adba9e43599a096
 SHA512:
-  metadata.gz: cea0d86d27e200156e9f08ab505e32bd576ac6977de4965df0393e3106a92d549185577f580fc8a6b6d414ce4c1a1883496b3ec05b2a2776921b674768b8c759
-  data.tar.gz: f16548cd8666e6d8e9ee9f31f16c1d1dadf93d06a8c05e09397553ac9246b962503aabba2b8480a67f360b65275b4638e9d23b12c52c717d82c472fe0151e5af
+  metadata.gz: fbc3c226031a49c023c5d901908903b1cbeffcef8f99cae0c9c0a88e193a25cace270144070995410546fd04d79734124cbbef904cd873992987bba74fc69fc6
+  data.tar.gz: 8abd4c2833d6210a4aa29c5dacb72bea903fa94c86fb1d30523622127976879a93dbcdbba8f5ffe417d16072828d87b58e364ca594b3746955c7edc01fcd76e1

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    strapi (0.0.1)
+    strapi (0.0.2)
       activesupport (>= 5.0)
       faraday (>= 1.0)
       oj (>= 3.0)
@@ -23,25 +23,8 @@ GEM
     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)
+    faraday (2.0.0)
       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)
@@ -49,7 +32,6 @@ GEM
     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)

data/README.md

@@ -12,6 +12,12 @@ your Strapi content types as it is to define them within Strapi itself.
 Add this line to your application's Gemfile:
 
 ```ruby
+gem 'strapi'
+```
+
+Or if you want to run the absolute latest, potentially unreleased version:
+
+``` ruby
 gem 'strapi', github: 'waymondo/strapi-ruby'
 ```
 
@@ -19,11 +25,11 @@ 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
 
+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
@@ -37,7 +43,7 @@ STRAPI_HOST_URL=http://localhost:1337
 STRAPI_API_TOKEN=asdf1234qwer5678
 ```
 
-#### Defining Content Type Classes
+### Defining Content Type Classes
 
 In Ruby, define some content type classes, i.e.:
 
@@ -107,7 +113,7 @@ parameter options are included by default, so if you want to eagerly load relate
 example, you’ll need to specify that with the `populate` option:
 
 ``` ruby
-cows = Cow.all(populate: "*")
+cows = Cow.all(populate: '*')
 cows.first.farm.name # => "McDonald’s"
 farm = Farm.find(1, populate: ['cows'])
 farm.cows.first.name # => "Hershey"
@@ -116,9 +122,49 @@ 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
+### Creating, Updating, Deleting
+
+You can create and update entries by calling `.save` on them:
+
+``` ruby
+cow = Cow.new(name: 'Hershey')
+cow.id # => nil
+cow.save # => performs POST request
+cow.id # => 1
+cow = Cow.find(1)
+cow.name = 'Bessie'
+cow.save # => performs PUT request
+```
+
+You can also use `create` class method to more concisely create entries:
 
-Coming Soon
+``` ruby
+cow = Cow.create(name: 'Bessie')
+cow.id # => 1
+```
+
+You can delete entries by calling `.delete` on them:
+
+``` ruby
+cow = Cow.find(1)
+cow.delete # => performs DELETE request
+cow = Cow.find(1) # => raises Strapi::Error
+```
+
+### Error Handling
+
+Any non successful Strapi request will raise a
+[Strapi::Error](https://github.com/waymondo/strapi-ruby/blob/main/lib/strapi/error.rb) with the API
+response’s status, message, and payload, which you can rescue and handle accordingly:
+
+``` ruby
+def show
+  cow = Cow.find(123)
+  render :cow, cow: cow
+rescue Strapi::Error => e
+  render :error, message: e.message
+end
+```
 
 ## Development
 
@@ -133,7 +179,7 @@ file to [rubygems.org](https://rubygems.org).
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/waymondo/strapi.
+Bug reports and pull requests are welcome on GitHub at https://github.com/waymondo/strapi-ruby.
 
 ## License
 

data/lib/strapi/content_type.rb

@@ -3,31 +3,57 @@
 module Strapi
   # The class for defining a Ruby class that represents a Strapi Content-Type
   class ContentType
-    attr_reader :id, :attributes
+    attr_reader :id, :attributes, :deleted
 
-    def initialize(response_data)
-      @id = response_data['id']
-      @attributes = response_data['attributes'].transform_keys(&:underscore)
+    def initialize(attributes = {})
+      @attributes = attributes.symbolize_keys
     end
 
-    def created_at
-      datetime_from_timestamp 'created_at'
+    %w[created_at updated_at published_at].each do |method|
+      define_method(method) do
+        datetime_from_timestamp method
+      end
     end
 
-    def updated_at
-      datetime_from_timestamp 'updated_at'
+    def ==(other)
+      other.is_a?(self.class) && id == other.id
     end
 
-    def published_at
-      datetime_from_timestamp 'published_at'
+    def save(query_hash = {})
+      return if deleted
+
+      response = id ? update_request(query_hash) : create_request(query_hash)
+      entry = self.class.send(:new_from_response, response)
+      tap do
+        @attributes = attributes.deep_merge entry.attributes
+        @id = entry.id
+      end
     end
 
-    def ==(other)
-      other.is_a?(self.class) && id == other.id
+    def delete(query_hash = {})
+      Request.delete("#{self.class.send(:_plural_id)}/#{id}?#{query_hash.to_query}")
+      @attributes = {}
+      @id = nil
+      @deleted = true
+      nil
     end
 
     private
 
+    def create_request(query_hash)
+      Request.post(
+        "#{self.class.send(:_plural_id)}?#{query_hash.to_query}",
+        data: attributes.slice(*self.class.fields)
+      ).data
+    end
+
+    def update_request(query_hash)
+      Request.put(
+        "#{self.class.send(:_plural_id)}/#{id}?#{query_hash.to_query}",
+        data: attributes.slice(*self.class.fields)
+      ).data
+    end
+
     def datetime_from_timestamp(key)
       return unless (timestamp = @attributes[key])
 
@@ -35,36 +61,41 @@ module Strapi
     end
 
     def strapi_attr_value(attr, options)
-      value = @attributes[attr.to_s]
+      value = @attributes[attr]
       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)
+          content_type_class.send(:new_from_response, entry)
         end
       else
-        content_type_class.new(data)
+        content_type_class.send(:new_from_response, data)
       end
     end
 
     class << self
+      attr_reader :fields
+
       def plural_id(name)
         @_plural_id = name
       end
 
       def field(attr, options = {})
+        @fields = [] if fields.nil?
+        fields << attr
+
         define_method attr do
           strapi_attr_value(attr, options)
         end
 
         define_method "#{attr}=" do |value|
-          attributes[attr.to_s] = value
+          attributes[attr] = value
         end
       end
 
       def find(id, query_hash = {})
-        new Request.get("#{_plural_id}/#{id}?#{query_hash.to_query}").data
+        new_from_response Request.get("#{_plural_id}/#{id}?#{query_hash.to_query}").data
       end
 
       def all(query_hash = {})
@@ -75,16 +106,22 @@ module Strapi
         get_list(query_hash)
       end
 
+      def create(attributes, query_hash = {})
+        new(attributes).save(query_hash)
+      end
+
       private
 
-      def get_list(query_hash)
-        strapi_filter_query(query_hash).map do |result|
-          new result
+      def new_from_response(response)
+        new(response['attributes'].transform_keys(&:underscore)).tap do |entry|
+          entry.instance_variable_set('@id', response['id'])
         end
       end
 
-      def strapi_filter_query(query_hash)
-        Request.get("#{_plural_id}?#{query_hash.to_query}").data
+      def get_list(query_hash)
+        Request.get("#{_plural_id}?#{query_hash.to_query}").data.map do |result|
+          new_from_response result
+        end
       end
 
       def _plural_id

data/lib/strapi/response.rb

@@ -7,9 +7,6 @@ module Strapi
 
     def initialize(faraday_response)
       @parsed_response = Oj.load(faraday_response.body)
-      puts '########################'
-      p @parsed_response
-      puts '########################'
       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.1'
+  VERSION = '0.0.2'
 end

data/lib/strapi.rb

@@ -3,6 +3,7 @@
 require 'active_support'
 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'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: strapi
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - justin talbott
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-01-04 00:00:00.000000000 Z
+date: 2022-01-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -75,12 +75,12 @@ files:
 - lib/strapi/request.rb
 - lib/strapi/response.rb
 - lib/strapi/version.rb
-homepage: https://github.com/waymondo/strapi
+homepage: https://github.com/waymondo/strapi-ruby
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/waymondo/strapi
-  source_code_uri: https://github.com/waymondo/strapi
+  homepage_uri: https://github.com/waymondo/strapi-ruby
+  source_code_uri: https://github.com/waymondo/strapi-ruby
   rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []