unlock_gateway 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f5d850aa0d3ed3fd0b0bf454f3201145e58371c8
-  data.tar.gz: 40b6558504281e14ac326f9e251a1d3139454ff5
+  metadata.gz: 5a899941b45bf6475771f02b67696673e27a90e8
+  data.tar.gz: 31b1d3c340898adf93489c7abd8c5749e0022de3
 SHA512:
-  metadata.gz: 02e7cf6b6c41b3d84baf1b4f5eabf9ae3aba78884228f518b6207bc912f29379fb5d72ba62ea2293528e21ec0c7b3bfd45e6f0b1712a1de6148d94fd6f04a508
-  data.tar.gz: b48cb6232a14b6b5e026e3d0db793713399174c803dcab471a9ec16816acf1ab5b572f9c08eac13732bb1b86a1e619f3e13c52b44f2b0395cca9d944ba6f66f3
+  metadata.gz: ddfc78a147f2c1078fe116a5adaa9ee8cc03ab40b128f526a2b7b37f747c9451270b6afa187789163c61161bd914b11508b76230d3e532e9daba1caab82c944e
+  data.tar.gz: f6723e0bdefb4c895e139ab6f8725b2af92e123ad3ca7c91ddc6e4ba932ed6f54e5ac158cc537cb6d18c30b05edc70de7665dc62260534c1aa6f9d3a8b5704a6

data/lib/unlock_gateway/models/contribution.rb

@@ -1,10 +1,14 @@
 module UnlockGateway
   module Models
+
+    # This module will be included in Unlock's Contribution model. All methods will run in the context of an instance of Contribution model.
     module Contribution
 
+      # This method should implement a way to check the state of the subscription with the gateway and update the contribution's state according to it's real state within the gateway.
       def update_state_from_gateway!
       end
 
     end
+
   end
 end

data/lib/unlock_gateway/models/gateway.rb

@@ -1,28 +1,37 @@
 module UnlockGateway
   module Models
+
+    # This module will be included in Unlock's Gateway model. All methods will run in the context of an instance of Gateway model.
     module Gateway
 
+      # This method should return the name of the payment gateway to be displayed in Unlock's gateways configurations.
       def name
         self.module_name
       end
 
+      # This method should return the description of the payment gateway to be displayed in Unlock's gateways configurations.
       def description
       end
 
+      # This method should return the image PATH of the payment gateway to be displayed in Unlock's gateways configurations, such as 'my_gateway/logo.png'.
       def image
       end
 
+      # This method should return the path for the routes generated by the gateway, such as '/my_gateway'.
       def path
       end
 
+      # This method should return true if the gateway has a sandbox alternative and false if not.
       def has_sandbox?
         true
       end
 
+      # This method should return an Array of UnlockGateway::Setting that will be displayed when configuring the gateway's settings. Here is the place for API keys, etc.
       def available_settings
         []
       end
 
     end
+    
   end
 end

data/lib/unlock_gateway/version.rb

@@ -1,3 +1,3 @@
 module UnlockGateway
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: unlock_gateway
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Daniel Weinmann