active_jobject 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 25a4e56c18e49c5151fef9020b24fa6ff7e9c5f753e7bc31035cfd906fb27c41
-  data.tar.gz: f39f850277672136d0d87ef6685088f480c09218a7a27879e4d79ad1665016b6
+  metadata.gz: 670bb39c934b36b744850d38292acbd8a4f52f803ce5a1e1fbb63ded05f7214f
+  data.tar.gz: '077906e8eb34e510ace5ccd53987cbe7c93d30bcca4a0e3a0d288a33bba10354'
 SHA512:
-  metadata.gz: c64b52c489aeb0e289fa348ae08583a5ba8f523a2cfec7222f1bbf265ca28e557d76f0fe6bd0a24e711c64321f6c0366503b87c185358caf31ea58f3ac94aab4
-  data.tar.gz: a906370c3219908a1b1ca5dbd9c3b5270b05a9b9326eaf72398bfdc4b856135332202546ccb38877a3b393e0e8254ed5bfb86f5f9e6ecd71e3fff16e4d3e5f33
+  metadata.gz: fc1677943c1e48da4948b863efb15bdc98a9704e4a7b9ad26ad1c19e497ee01606705d28f222359bee21dfc950d6661807a2fc9cc5ace8906137e41501ca7ad2
+  data.tar.gz: 935bc42d0d4623293abaa99821955689e03c2e5cf28888cc57d4ffed400452d72cc8f79e3915ae392be2e4162bc579f53ef253406df4f3182efc86e5edb6042d

data/README.md

@@ -1,4 +1,5 @@
 # ActiveJobject
+[![Gem Version](https://badge.fury.io/rb/active_jobject.svg?icon=si%3Arubygems)](https://badge.fury.io/rb/active_jobject)
 
 Yes ActiveJobject, as in Active JSON Object (clever I know). This gem is built as a wraper for handling external connections with parsers and authentication built-in. It also supports 
 several HTTP request / gem so you can use your own `engine` or gem that better suits your needs. It also comes packaged with it's own error handling, allowing for more consistent and standard error handling cross-project.

data/lib/active_jobject/base.rb

@@ -4,20 +4,62 @@ module ActiveJobject
   class Base
     include ActiveJobject::Request
 
+    def initialize(**)
+      parse(self, **)
+    end
+
     class << self
-      attr_accessor :_site
+      attr_writer :_site, :_ignored_keys
 
-      def site
-        _site
+      def _site
+        if defined?(@_site)
+          @_site
+        elsif superclass.respond_to?(:_site)
+          superclass._site
+        end
       end
 
-      def site=(site)
-        self._site = site
+      alias site _site
+      alias site= _site=
+
+      def _ignored_keys
+        if instance_variable_defined?(:@_ignored_keys)
+          @_ignored_keys
+        elsif superclass.respond_to?(:_ignored_keys)
+          superclass._ignored_keys
+        else
+          []
+        end
+      end
+
+      alias ignored_keys _ignored_keys
+      alias ignored_keys= _ignored_keys=
+
+      def uri
+        _site.is_a?(URI) ? _site : URI(_site)
       end
     end
 
-    def uri
-      self.class._site.is_a?(URI) ? self.class._site : URI(self.class._site)
+    def uri = self.class.uri
+
+    def to_h(symbolize_keys: true)
+      instance_variables.to_h do |var|
+        key = var.to_s.delete('@')
+        key = key.to_sym if symbolize_keys
+
+        [key, serialize_value(instance_variable_get(var), symbolize_keys:)]
+      end
+    end
+
+    private
+
+    def serialize_value(value, symbolize_keys:)
+      case value
+      when ActiveJobject::Base then value.to_h(symbolize_keys:)
+      when Array then value.map { |v| serialize_value(v, symbolize_keys:) }
+      when Hash then value.transform_values { |v| serialize_value(v, symbolize_keys:) }
+      else value
+      end
     end
   end
 end

data/lib/active_jobject/parser.rb

@@ -8,15 +8,10 @@ module ActiveJobject
       raise InvalidInstance, "Class #{klass&.name || klass} is not an instance." if klass.is_a?(Class)
 
       attributes.each do |attribute, value|
-        return_value = if value.is_a?(Array)
-          parse_array(klass, attribute, value)
-        elsif value.is_a?(Hash)
-          parse_hash(klass, attribute, value)
-        else
-          value
-        end
+        result = parse_method(klass, attribute, value)
+        class_method_value = result.nil? ? value : result
 
-        define_singleton_methods(klass, attribute, return_value)
+        define_singleton_methods(klass, attribute, class_method_value)
       end
 
       klass
@@ -65,5 +60,22 @@ module ActiveJobject
         base_klass.const_set(name, klass)
       end
     end
+
+    def parse_method(klass, attribute, value)
+      return nil if ignored_keys.include?(attribute)
+
+      case value
+      when Array
+        return parse_array(klass, attribute, value)
+      when Hash
+        return parse_hash(klass, attribute, value)
+      end
+
+      nil
+    end
+
+    def ignored_keys
+      self.class.ignored_keys || []
+    end
   end
 end

data/lib/active_jobject/request/engine/oauth2.rb

@@ -96,8 +96,9 @@ module ActiveJobject
           end
 
           def deconstruct_uri(uri)
-            host_with_scheme = [80, 443].include?(uri.port) ? "#{uri.scheme}://#{uri.host}/" : "#{uri.scheme}://#{uri.host}:#{uri.port}/"
-            path = uri.path
+            default_port = (uri.scheme == 'https' && uri.port == 443) || (uri.scheme == 'http' && uri.port == 80)
+            host_with_scheme = default_port ? "#{uri.scheme}://#{uri.host}/" : "#{uri.scheme}://#{uri.host}:#{uri.port}/"
+            path = uri.query.nil? ? uri.path : "#{uri.path}?#{uri.query}"
 
             [host_with_scheme, path]
           end

data/lib/active_jobject/request.rb

@@ -4,17 +4,27 @@ module ActiveJobject
   module Request
     include ActiveJobject::Parser
 
+    class UnsupportedFormat < ActiveJobject::Error; end
+
     def self.included(base)
       base.extend(ClassMethods)
     end
 
     module ClassMethods
+      include ActiveJobject::Parser
+
       def engine=(engine)
         @engine = engine
       end
 
       def engine
-        @engine ||= ActiveJobject::Request::Engine::NetHttp
+        if instance_variable_defined?(:@engine)
+          @engine
+        elsif superclass.respond_to?(:engine)
+          superclass.engine
+        else
+          ActiveJobject::Request::Engine::NetHttp
+        end
       end
 
       def default_headers=(headers)
@@ -22,30 +32,75 @@ module ActiveJobject
       end
 
       def default_headers
-        @default_headers ||= {}
+        if instance_variable_defined?(:@default_headers)
+          @default_headers
+        elsif superclass.respond_to?(:default_headers)
+          superclass.default_headers
+        else
+          {}
+        end
       end
-    end
 
-    def get(headers: {}, params: {})
-      merged_headers = self.class.default_headers.merge(headers)
-      response = self.class.engine.get(site: uri, headers: merged_headers, params:)
+      private
 
-      parse(self, **JSON.parse(response.body))
-    end
+      def get(endpoint:, headers: {}, params: {})
+        merged_headers = default_headers.merge(headers)
+        response = engine.get(site: uri + endpoint, headers: merged_headers, params:)
 
-    def post(headers: {}, params: {}, body: nil)
-      merged_headers = self.class.default_headers.merge(headers)
-      response = self.class.engine.post(site: uri, headers: merged_headers, params:, body:)
+        build_response(JSON.parse(response.body))
+      end
 
-      parse(self, **JSON.parse(response.body))
-    end
+      def post(endpoint:, headers: {}, params: {}, body: nil)
+        merged_headers = default_headers.merge(headers)
+        response = engine.post(site: uri + endpoint, headers: merged_headers, params:, body:)
 
-    def put; end
+        build_response(JSON.parse(response.body))
+      end
+
+      def put(endpoint:, headers: {}, params: {}, body: nil)
+        merged_headers = default_headers.merge(headers)
+        response = engine.put(site: uri + endpoint, headers: merged_headers, params:, body:)
+
+        build_response(JSON.parse(response.body))
+      end
+
+      def patch(endpoint:, headers: {}, params: {}, body: nil)
+        merged_headers = default_headers.merge(headers)
+        response = engine.patch(site: uri + endpoint, headers: merged_headers, params:, body:)
 
-    def delete; end
+        build_response(JSON.parse(response.body))
+      end
+
+      def delete(endpoint:, headers: {}, params: {})
+        merged_headers = default_headers.merge(headers)
+        response = engine.delete(site: uri + endpoint, headers: merged_headers, params:)
+
+        build_response(JSON.parse(response.body))
+      end
+
+      def build_response(json)
+        if json.is_a?(Hash)
+          parse(new, **json)
+        elsif json.is_a?(Array)
+          ActiveJobject::Collection.new(json.map { |res| parse(new, **res) })
+        else
+          raise UnsupportedFormat "HTTP response not supported. (#{json.class})"
+        end
+      end
+    end
 
     private
 
+    def get(endpoint:, headers: {}, params: {}) = self.class.get(endpoint:, headers:, params:)
+
+    def post(endpoint:, headers: {}, params: {}, body: nil) = self.class.post(endpoint:, headers:, params:, body:)
+
+    def put(endpoint:, headers: {}, params: {}, body: nil) = self.class.put(endpoint:, headers:, params:, body:)
+
+    def patch(endpoint:, headers: {}, params: {}, body: nil) = self.class.patch(endpoint:, headers:, params:, body:)
+
+    def delete(endpoint:, headers: {}, params: {}, body: nil) = self.class.delete(endpoint:, headers:, params:, body:)
+
     def error_class(status)
       case status
       when 404

data/lib/active_jobject/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ActiveJobject
-  VERSION = '0.1.1'
+  VERSION = '0.2.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: active_jobject
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Guilherme Theodoro
@@ -54,7 +54,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 4.0.20
 specification_version: 4
 summary: HTTP Engine Object Wrapper
 test_files: []