hyper-resource 1.0.0.lap79 → 1.0.0.lap80

data/lib/hyperloop/resource/http.rb

@@ -1,11 +1,11 @@
 module Hyperloop
   module Resource
-    # {HTTP} is used to perform a `XMLHttpRequest` in ruby. It is a simple wrapper
+    # HTTP is used to perform a `XMLHttpRequest` in ruby. It is a simple wrapper
     # around `XMLHttpRequest`
     #
     # # Making requests
     #
-    # To create a simple request, {HTTP} exposes class level methods to specify
+    # To create a simple request, HTTP exposes class level methods to specify
     # the HTTP action you wish to perform. Each action accepts the url for the
     # request, as well as optional arguments passed as a hash:
     #
@@ -14,17 +14,17 @@ module Hyperloop
     #
     # The supported `HTTP` actions are:
     #
-    # * {HTTP.get}
-    # * {HTTP.post}
-    # * {HTTP.put}
-    # * {HTTP.delete}
-    # * {HTTP.patch}
-    # * {HTTP.head}
+    # * HTTP.get
+    # * HTTP.post
+    # * HTTP.put
+    # * HTTP.delete
+    # * HTTP.patch
+    # * HTTP.head
     #
     # # Handling responses
     #
     # Responses can be handled using either a simple block callback, or using a
-    # {Promise} returned by the request.
+    # Promise returned by the request.
     #
     # ## Using a block
     #
@@ -36,8 +36,8 @@ module Hyperloop
     #       puts "the request has completed!"
     #     end
     #
-    # This `request` object will simply be the instance of the {HTTP} class which
-    # wraps the native `XMLHttpRequest`. {HTTP#ok?} can be used to quickly determine
+    # This `request` object will simply be the instance of the HTTP class which
+    # wraps the native `XMLHttpRequest`. HTTP#ok? can be used to quickly determine
     # if the request was successful.
     #
     #     HTTP.get("/users/1") do |request|
@@ -48,11 +48,11 @@ module Hyperloop
     #       end
     #     end
     #
-    # The {HTTP} instance will always be the only object passed to the block.
+    # The HTTP instance will always be the only object passed to the block.
     #
     # ## Using a Promise
     #
-    # If no block is given to one of the action methods, then a {Promise} is
+    # If no block is given to one of the action methods, then a Promise is
     # returned instead. See the standard library for more information on Promises.
     #
     #     HTTP.get("/users/1").then do |req|
@@ -61,20 +61,20 @@ module Hyperloop
     #       puts "response was not ok"
     #     end
     #
-    # When using a {Promise}, both success and failure handlers will be passed the
-    # {HTTP} instance.
+    # When using a Promise, both success and failure handlers will be passed the
+    # HTTP instance.
     #
     # # Accessing Response Data
     #
-    # All data returned from an HTTP request can be accessed via the {HTTP} object
+    # All data returned from an HTTP request can be accessed via the HTTP object
     # passed into the block or promise handlers.
     #
-    # - {#ok?} - returns `true` or `false`, if request was a success (or not).
-    # - {#body} - returns the raw text response of the request
-    # - {#status_code} - returns the raw {HTTP} status code as integer
-    # - {#json} - tries to convert the body response into a JSON object
+    # - #ok? - returns `true` or `false`, if request was a success (or not).
+    # - #body - returns the raw text response of the request
+    # - #status_code - returns the raw {HTTP} status code as integer
+    # - #json - tries to convert the body response into a JSON object
     class HTTP
-      # All valid {HTTP} action methods this class accepts.
+      # All valid HTTP action methods this class accepts.
       #
       # @see HTTP.get
       # @see HTTP.post
@@ -112,7 +112,7 @@ module Hyperloop
       # @param url [String] url for request
       # @param options [Hash] optional request options
       # @yield [self] optional block to yield for response
-      # @return [Promise, nil] returns a {Promise} unless block given
+      # @return [Promise, nil] returns a Promise unless block given
 
       # @!method self.put(url, options = {}, &block)
 
@@ -138,6 +138,8 @@ module Hyperloop
         @ok = true
       end
 
+      # check if requests are still active
+      # return [Boolean]
       def self.active?
         jquery_active_requests = 0
         %x{
@@ -148,16 +150,19 @@ module Hyperloop
         (jquery_active_requests + @active_requests) > 0
       end
 
+      # @private
       def self.active_requests
         @active_requests ||= 0
         @active_requests
       end
 
+      # @private
       def self.incr_active_requests
         @active_requests ||= 0
         @active_requests += 1
       end
 
+      # @private
       def self.decr_active_requests
         @active_requests ||= 0
         @active_requests -= 1
@@ -167,6 +172,7 @@ module Hyperloop
         end
       end
 
+      # @private
       def send(method, url, options, block)
         @method   = method
         @url      = url
@@ -266,12 +272,15 @@ module Hyperloop
         }
       end
 
+      # inspect on request
+      # @return [String]
       def inspect
         "#<HTTP @url=#{@url} @method=#{@method}>"
       end
 
       private
 
+      # @private
       def promise
         return @promise if @promise
 
@@ -286,6 +295,7 @@ module Hyperloop
         }
       end
 
+      # @private
       def succeed(data, status, xhr)
         %x{
           #@body = data;
@@ -300,6 +310,7 @@ module Hyperloop
         @handler.call self if @handler
       end
 
+      # @private
       def fail(xhr, status, error)
         %x{
           #@body = xhr.responseText;

data/lib/hyperloop/resource/pub_sub.rb

@@ -6,6 +6,7 @@ module Hyperloop
       end
 
       module ClassMethods
+        # @private
         def _pusher_client
           Hyperloop.pusher_instance ||= Pusher::Client.new(
             app_id: Hyperloop.pusher[:app_id],
@@ -16,6 +17,7 @@ module Hyperloop
         end
       end
 
+      # (see HyperRecord::ClassMethods#publish_record)
       def publish_record(record)
         subscribers = Hyperloop.redis_instance.hgetall("HRPS__#{record.class}__#{record.id}")
         time_now = Time.now.to_f

data/lib/hyperloop/resource/version.rb

@@ -1,5 +1,5 @@
 module Hyperloop
   module Resource
-    VERSION = '1.0.0.lap79'
+    VERSION = '1.0.0.lap80'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hyper-resource
 version: !ruby/object:Gem::Version
-  version: 1.0.0.lap79
+  version: 1.0.0.lap80
 platform: ruby
 authors:
 - Jan Biedermann
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-03 00:00:00.000000000 Z
+date: 2018-06-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opal
@@ -192,6 +192,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.13
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.13
 description: Write Browser Apps that transparently access server side resources like
   'MyModel.first_name', with ease
 email: jan@kursator.de
@@ -199,8 +213,53 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
+- ".yardopts"
+- API.md
+- Gemfile
+- JSON_format.md
 - LICENSE
+- PubSub.md
 - README.md
+- Security.md
+- docs/HyperRecord.html
+- docs/HyperRecord/ClassMethods.html
+- docs/HyperRecord/ClientInstanceMethods.html
+- docs/HyperRecord/Collection.html
+- docs/HyperRecord/DummyValue.html
+- docs/HyperRecord/PubSub.html
+- docs/HyperRecord/PubSub/ClassMethods.html
+- docs/HyperRecord/ServerClassMethods.html
+- docs/Hyperloop.html
+- docs/Hyperloop/Resource.html
+- docs/Hyperloop/Resource/ClientDrivers.html
+- docs/Hyperloop/Resource/HTTP.html
+- docs/Hyperloop/Resource/MethodsController.html
+- docs/Hyperloop/Resource/PropertiesController.html
+- docs/Hyperloop/Resource/PubSub.html
+- docs/Hyperloop/Resource/PubSub/ClassMethods.html
+- docs/Hyperloop/Resource/RelationsController.html
+- docs/Hyperloop/Resource/ScopesController.html
+- docs/Hyperloop/Resource/SecurityError.html
+- docs/Hyperloop/Resource/SecurityGuards.html
+- docs/Hyperloop/Resource/SecurityGuards/ClassMethods.html
+- docs/_index.html
+- docs/class_list.html
+- docs/css/common.css
+- docs/css/full_list.css
+- docs/css/style.css
+- docs/file.API.html
+- docs/file.JSON_format.html
+- docs/file.PubSub.html
+- docs/file.README.html
+- docs/file_list.html
+- docs/frames.html
+- docs/index.html
+- docs/js/app.js
+- docs/js/full_list.js
+- docs/js/jquery.js
+- docs/method_list.html
+- docs/top-level-namespace.html
 - hyper-resource.gemspec
 - lib/hyper-resource.rb
 - lib/hyper_record.rb