remote_entity 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 33a2e9d809f7e4a0c941f234aa3e3d3c7233934cb476b44505ea12ae8980847d
-  data.tar.gz: 3eadac241251a0e74fa92673864799579bc20b3fb6fd8d8fd894566379b56caf
+  metadata.gz: 0d8b35779a4cd6204b0f6358cee10e4eb64d168f73fecb5295d50bd8659993b4
+  data.tar.gz: b0e7d3508d849c0de2c3025059be4658890dc73f5d396ecc3f14b1f55536a2c2
 SHA512:
-  metadata.gz: 4a4ddfb164a2ab1c6509fbfba0892ae8e0c8a0edc3c23fb67e8235971ee58c4df6dd585d0bba8f7cdd9f1b161bef0d23c4b3143676531b0c22811f6389e15184
-  data.tar.gz: 3512aaac40f588bae7f232b77e8953662718182d0473ce946ca7cacd8839fef15633c042330c601bb201167b6060718688a585d0f17a4d8ab551c075631f974e
+  metadata.gz: 274f9feec9c4c1a44513b0e0caf1875d0e5463b836c10d086a61e6140b7b09335c921039b2dd3c086c11f981bed0e39fd2048eae60f760bba645d83ecb1eef80
+  data.tar.gz: 85d6388a3d9d9414f7db1a0b0eadc094f30cdce523360d0593ee3e16bb11ed18103e0d415ef692f76fbe9612c63e74cc8f435da2aa3176c1c26313732806d5ef

data/CHANGELOG.md

@@ -1,3 +1,7 @@
 ## [1.0.0] - 2024-01-18
 
 - Initial release
+
+## [2.0.0] - 2024-02-09
+
+- Add `RemoteEntity` namespace to class generated. For example, `RemoteEntity::User`.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    remote_entity (1.0.0)
+    remote_entity (2.0.0)
       cgi (~> 0.2)
       oauth2 (~> 2.0)
 
@@ -35,7 +35,7 @@ GEM
       ast (~> 2.4.1)
       racc
     racc (1.7.3)
-    rack (3.0.8)
+    rack (3.0.9)
     rainbow (3.1.1)
     rake (13.1.0)
     regexp_parser (2.9.0)

data/README.md

@@ -58,15 +58,29 @@ RemoteEntity.configure(
     }
 )
 ```
+The configuration generated `RemoteEntity::User` class with `find` method which can be used by the following example:
+
+```
+RemoteEntity::User.find(id: 1, public: true)
 ```
-User.find(id: 1, public: true)
+**NOTE**:
+- All entity classes created are under `RemoteEntity` namespace.
+- The classes generated are a typical Ruby class which can be extended, inherited. For example:
 ```
-Above will translate to following `GET` http request. `param_mapping` will transform any `path parameter`, and `query parameter` of the request into `User` entity method parameter.
+class UserService < RemoteEntity::User
+
+end
+```
+- The methods generated are `class method`.
+- The method parameter generated from configuration is always key/value pairs (hash)
+
+The method parameters will be transformed into `path parameter`, `query parameter` or `body parameter` of the request by `param_mapping` configuration. It makes the following `GET` http request:
 ```
 curl --location 'https://example.com/users/1?public=true' \
 --header 'Content-Type: application/json' \
 --header 'Authorization: Bearer <token>'
 ```
+
 `Content-Type` header as `application/json` is by default.
 
 `Authorization` header is generated by oauth2 request using grant type defined in the configuration. The example above uses ouath2 client_credentials grant type. (The gem uses [oauth2](https://gitlab.com/oauth-xx/oauth2/) gem underdying, so the param structure is pretty the same as oauth2)
@@ -79,10 +93,11 @@ Since the `find` method is configured to return value (`r_turn` is set to `true`
     age: 22
 }
 ```
+The configuration also creates `create` method. For example:
 ```
-User.create(name: "John", age: 23)
+RemoteEntity::User.create(name: "John", age: 23)
 ```
-Above will translate to following `POST` http request. `param_mapping` will transform `body parameter` of the request into `User` entity method parameter.
+It will make the following `POST` http request:
 ```
 curl --location 'https://example.com/users' \
 --header 'Content-Type: application/json' \
@@ -94,9 +109,7 @@ curl --location 'https://example.com/users' \
 ```
 It has no authorization configured, so no `Authorization` header.
 
-It does not return anything as `r_turn` is set to `false`
-
-**NOTE**: All http request params whether it is query parameter, path parameter or body parameter, it will always transform into key/value pairs parameter of the entity method.
+It does not return anything as `r_turn` is set to `false`.
 
 ## Contributing
 

data/lib/remote_entity/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RemoteEntity
-  VERSION = "1.0.0"
+  VERSION = "2.0.0"
 end

data/lib/remote_entity.rb

@@ -16,7 +16,7 @@ module RemoteEntity
     raise "missing required parameter - name" if options[:name].nil?
     raise "missing required parameter - methods" if options[:methods].nil?
 
-    Object.const_set(options[:name], RemoteEntity.build_dynamic_class(options))
+    RemoteEntity.const_set(options[:name], build_dynamic_class(options))
   end
 
   def self.build_dynamic_class(options)
@@ -104,4 +104,6 @@ module RemoteEntity
     token = client.send(grant_type).get_token(scope: credentials_info[:scope]).token
     "Bearer #{token}"
   end
+
+  private_class_method :build_dynamic_class
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: remote_entity
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Kuroun Seung
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-01-18 00:00:00.000000000 Z
+date: 2024-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cgi