pragma-operation 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d1a35deac8b18a13c8f5e7cd9b4ee1372afb6321
-  data.tar.gz: 6f2abba3db47e143d06c407fe33a1416f44cffac
+  metadata.gz: a892b513da3edcb6fd3fbf84964cb4773671d4f5
+  data.tar.gz: 2dd06285a00dcb6ed694d8050efde1c346e985c6
 SHA512:
-  metadata.gz: 1af71177cbec88e40273ebc84fd5118d2bf2d894df7823791850e50d12dcd5ca0e2ba649b6c4509ff71708bfdafb3bd13ba78064cdc78709f9a3e59267c1626d
-  data.tar.gz: fd674718c93267c02e48e6ce035ff0595a1cb6db79ed047938a762ae4e555ed35e9be6348ec02d5b0aed038fe428f64c738fc10edd7c62498b9c24bec37976bb
+  metadata.gz: 545a8a3f2db0168d4bfa8b1ebfd14e212dc1f44de3408c2f65ca0320e8dff52cefa274abbd9e16701af7755c14b55983989759cc60ebf093e181fea83718824a
+  data.tar.gz: 0ca767a0c19c14961a2b78be730b39d568d777890156982e67bf98354d56a77541e045145766798343e38358074167f2d242d75dde56f5e87df4af4a621e0f1f

data/doc/01-basic-usage.md

@@ -9,7 +9,14 @@ module API
       module Operation
         class Create < Pragma::Operation::Base
           def call
-            respond_with status: :ok, resource: { pong: params[:pong] }
+            # The `status` parameter is optional (the default is `:ok`).
+            respond_with(
+              status: :ok,
+              resource: { pong: params[:pong] },
+              headers: {
+                'X-Ping-Time' => Time.now.to_i
+              }
+            )
           end
         end
       end
@@ -25,6 +32,7 @@ result = API::V1::Ping::Operation::Create.call(params: { pong: 'HELLO' })
 
 result.status # => :ok
 result.resource # => { pong: 'HELLO' }
+result.headers # => { 'X-Ping-Time' => 1482927872 }
 ```
 
 As you can see, an operation takes parameters as input and responds with:

data/lib/pragma/operation/base.rb

@@ -114,27 +114,26 @@ module Pragma
 
       # Sets the status and resource to respond with.
       #
-      # You can achieve the same result by setting +context.status+ and +context.resource+ wherever
-      # you want in {#call}.
+      # You can achieve the same result by setting +context.status+, +context.headers+ and
+      # +context.resource+ wherever you want in {#call}.
       #
       # Note that calling this method doesn't halt the execution of the operation and that this
       # method can be called multiple times, overriding the previous context.
       #
       # @param status [Integer|Symbol] an HTTP status code
+      # @param headers [Hash] HTTP headers
       # @param resource [Object] an object responding to +#to_json+
-      def respond_with(status:, resource:)
+      def respond_with(status: :ok, headers: {}, resource:)
         context.status = status
+        context.headers = headers.to_h
         context.resource = resource
       end
 
       # Same as {#respond_with}, but also halts the execution of the operation.
       #
-      # @param status [Integer|Symbol] an HTTP status code
-      # @param resource [Object] an object responding to +#to_json+
-      #
       # @see #respond_with
-      def respond_with!(status:, resource:)
-        respond_with status: status, resource: resource
+      def respond_with!(*args)
+        respond_with *args
         fail Halt
       end
 
@@ -187,6 +186,7 @@ module Pragma
 
       def setup_context
         context.params ||= {}
+        context.headers = {}
       end
 
       def handle_halt(interactor)

data/lib/pragma/operation/decoration.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Pragma
   module Operation
     # Provides integration with {https://github.com/pragmarb/pragma-decorator Pragma::Decorator}.

data/lib/pragma/operation/validation.rb

@@ -59,7 +59,6 @@ module Pragma
         #
         # @return [Boolean] whether the operation is valid
         def validate(validatable)
-          # rubocop:disable Metrics/LineLength
           contract = if validatable.is_a?(self.class.contract_klass)
             validatable
           else

data/lib/pragma/operation/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 module Pragma
   module Operation
-    VERSION = '1.0.0'
+    VERSION = '1.1.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pragma-operation
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Alessandro Desantis
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-12-27 00:00:00.000000000 Z
+date: 2016-12-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: interactor