http_fp 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 850b1b6981a06a01b80d3bd85977c2e5d53c27d1
-  data.tar.gz: 970d21732d1ac8e56458ec0ab9d7aeddda38b935
+SHA256:
+  metadata.gz: f3b73d8ca4247f899573be513abede0492ba73f7cb218af122722b6cf98d26bb
+  data.tar.gz: 6fdc1f65704f8c26814ea824707a4f20545b8bada1365ae424095b0af0afbb7e
 SHA512:
-  metadata.gz: ec15f9f91bac213932505fa2baef913b2fe709e72e8b423f037754e8f25d7313cadc72d8bab16ab0208c004f922e75195424a84773d3362cb958be5237885720
-  data.tar.gz: ff47e1c252f0abe9b85cbfe601ff4e1223e8844d55c4838a7556c1afd1669e784ebc72a07749829fe1931b2e2a6b7db78237d4135ae2a30dc67db10e72f27e4a
+  metadata.gz: f62b4abfc4d345d0c04031291c04f90165b3cf72c84aee63c66d9fa92413f711ec5bce0374ab114e4b78d9045658f651bfedf533fa0a381777eeb160df394c2b
+  data.tar.gz: 47a8d5fc2ff42cfeefded5c8bf36ccfc8b1499bff2b1592cca62d3b6469375880081aa33c46e862a7de0f62437e6e798312fb06e7e648dc495c98f1c7638f803

data/.ruby-version

@@ -1 +1 @@
-2.1.2
+2.6

data/README.md

@@ -25,12 +25,12 @@ Here's an example of a request:
  :body=>""}
 ```
 
-To build that request you can use builder functions and the function composition operator ([`>>~`](https://github.com/martinos/http_fp/blob/master/lib/http_fp/operators.rb#L4)). Every builder function adds values to the response object.  Example: 
+To build that request you can use builder functions and the function composition operator ([`>>`](https://docs.ruby-lang.org/en/2.6.0/Proc.html#method-i-3E-3E)). Every builder function adds values to the response object.  Example: 
 
 ```ruby
-query = verb.("get") >>~ 
-        with_path.("/users/martinos/repos") >>~ 
-        with_host.("https://api.github.com") >>~ 
+query = verb.("get") >>
+        with_path.("/users/martinos/repos") >>
+        with_host.("https://api.github.com") >>
         add_headers.(json_headers)
 ```
 The `query` variable is a builder function that is created by combining multiple builder functions together.
@@ -51,7 +51,6 @@ pp empty_req
  :body=>""}
 ```
 
-<<<<<<< HEAD
 We apply the `empty_req` to the query that we've built.
 ```ruby
 pp query.(empty_req)
@@ -86,16 +85,70 @@ HttpFp::NetHttp.server.(query.(empty_req))
 
 ```
 
-You can also use the pipe operator ([`>>+`](https://github.com/martinos/http_fp/blob/master/lib/http_fp/operators.rb#L8)) and the run function. The `run_` function takes a function as parameter and applies the `empty_req` to it.
-
-Here is it's definition:
 ```ruby
-run_ = -> fn { fn.(empty_req) }
+(query >> HttpFp::NetHttp.server).(empty_req)
 ```
 
+Since a "server" is just a function that takes an HTTP request and returns an HTTP response, instead of using Net::Http interface you can use the `HttpFp::Rack.server` function that takes a rack app as parameter.
+
 ```run
-query >>~ HttpFp::NetHttp.server >>+ run_
+query >> HttpFp::Rack.server.(Rails.application)
+```
+
+## Middlewares
+
+Since we are using composable functions to build our request and to query the web server, it's very easy to create our own "middlewares".
+
+If we want to all the request and the response we can create a simple function such as:
+
+```
+debug_fn = -> print, fn, input {
+  print.("Input: \n")
+  print.(input.to_s)
+  output = fn.(input)
+  print.("Output: \n")
+  print.(output)
+  output
+}.curry
+
+```
+
+the `print` param is a function that prints an object.
+
+```
+printer = -> a { print a; a } 
+query >> debug_fn.(printer).(HttpFp::NetHttp.server)
+```
+
+of course you can change the printer to print to the log file.
+
 ```
+printer = -> a { logger.debug(a) ; a }
+```
+
+### Curl, Httpie output
+
+If you want to generate documentation with curl commands you can use a simple function such as:
+
+```
+curl = -> a { puts HttpFp::Curl.req.(a) ; a }.curry
+```
+
+Then you can use it with the query and the server function.
+
+```run
+query >> curl >> HttpFp::NetHttp.server
+```
+
+This will output:
+
+```
+curl -X 'GET' 'https://api.github.com/users/martinos/repos?' \
+    -H 'accept: application/json' \
+    -H 'Content-Type: application/json' \
+    -H 'user-agent: ruby net/http'
+```
+
 
 
 ## Contributing

data/http_fp.gemspec

@@ -22,6 +22,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "minitest"
   spec.add_dependency "rake", "~> 10.0"
   spec.add_dependency "rack"
-  spec.add_dependency "activesupport"
-  spec.add_dependency "superators19"
+  spec.add_dependency "fn_reader"
 end

data/lib/http_fp.rb

@@ -1,42 +1,43 @@
-require "active_support"
+require "fn_reader"
+require "uri"
+require "base64"
 require "http_fp/version"
-require 'http_fp/utils'
-require 'uri'
-require 'base64'
+require "http_fp/utils"
 
 module HttpFp
   include Utils
 
-  mattr_accessor :verb, :with_host, :with_path, :with_query, :withUri, 
-                 :with_json, :with_headers, :add_headers,  :fetch, :to_curl, 
-                 :out_curl, :json_resp, :to_uri, :empty_req, :json_headers,
-                 :with_basic_auth, :run_
+  fn_reader :verb, :with_host, :with_path, :with_query, :withUri,
+            :with_json, :with_headers, :add_headers, :fetch, :to_curl,
+            :out_curl, :json_resp, :to_uri, :empty_req, :json_headers,
+            :with_basic_auth, :run_
 
-  @@empty_req = {proto: "HTTP/1.1", host: "http://example.com", path: "/", query: {}, header: {}, method: "GET", body: ""}
-  @@empty_resp = {status: nil, header: {}, body: {}}
+  @@empty_req = { proto: "HTTP/1.1", host: "http://example.com", path: "/", query: {}, header: {}, method: "GET", body: "" }
+  @@empty_resp = { status: nil, header: {}, body: {} }
 
   @@run_ = -> fn { fn.(@@empty_req) } # underscore because run conflicts with run fn in minitest
-  @@verb = -> verb, req { req.merge({method: verb.to_s.upcase}) }.curry
+  @@verb = -> verb, req { req.merge({ method: verb.to_s.upcase }) }.curry
   @@with_host = -> host, req { req[:host] = host; req }.curry
   @@with_path = -> path, req { req[:path] = path; req }.curry
-  @@with_query = -> params, req { req[:query] = params ; req }.curry
+  @@with_query = -> params, req { req[:query] = params; req }.curry
   @@with_json = -> hash, req { req[:body] = hash.to_json; req }.curry
-  @@with_headers = -> header, req { req[:header] = header ; req }.curry
+  @@with_headers = -> header, req { req[:header] = header; req }.curry
   @@add_headers = -> header, req { req[:header].merge!(header); req }.curry
-  @@with_basic_auth = -> user_name, pwd, req do 
+  @@with_basic_auth = -> user_name, pwd, req do
     encoded = Base64.strict_encode64("#{user_name}:#{pwd}")
-    req >>+ add_headers.({"Authorization" => "Basic #{encoded}"})
+    req.then(&add_headers.({ "Authorization" => "Basic #{encoded}" }))
   end.curry
 
-  @@json_resp = Utils.at.(:body) >>~ Utils.parse_json
-  @@print = -> a { $stdout.puts a.pretty_inspect ; a }
+  @@json_resp = Utils.at.(:body) >> Utils.parse_json
+  @@print = -> a { $stdout.puts a.pretty_inspect; a }
   @@to_uri = -> req {
     uri = URI(req.fetch(:host))
     req[:query] && uri.query = URI.encode_www_form(req[:query])
     uri.path = req[:path]
-    uri}
-  @@json_headers = 
-    {"accept"     => "application/json",
-     'Content-Type' => 'application/json',
-     "user-agent" => "paw/3.0.11 (macintosh; os x/10.11.6) gcdhttprequest"}
+    uri
+  }
+  @@json_headers =
+    { "accept" => "application/json",
+      "Content-Type" => "application/json",
+      "user-agent" => "paw/3.0.11 (macintosh; os x/10.11.6) gcdhttprequest" }
 end

data/lib/http_fp/curl.rb

@@ -1,10 +1,10 @@
-require 'net/http'
-require 'http_fp'
+require "net/http"
+require "http_fp"
 
 module HttpFp::Curl
   include HttpFp
 
-  mattr_accessor :print_curl, :req
+  fn_reader :print_curl, :req
 
   @@req = -> req {
     first_part = %{curl -X '#{req[:method]}' '#{HttpFp::to_uri.(req).to_s}' #{req[:header].map(&@@header_to_curl).join(" ")}}
@@ -15,7 +15,8 @@ module HttpFp::Curl
     end
   }
   @@header_to_curl = -> a {
-    "\\\n    -H '#{a[0]}: #{a[1]}'"}
-  
-  @@print_curl = -> req { $stdout.puts(to_curl.(req)) ; req}.curry
+    "\\\n    -H '#{a[0]}: #{a[1]}'"
+  }
+
+  @@print_curl = -> req { $stdout.puts(to_curl.(req)); req }.curry
 end

data/lib/http_fp/httpie.rb

@@ -1,10 +1,10 @@
-require 'net/http'
-require 'http_fp'
+require "net/http"
+require "http_fp"
 
 module HttpFp::Httpie
   include HttpFp
 
-  mattr_accessor :print_curl, :req
+  fn_reader :print_curl, :req
 
   @@req = -> req {
     first_part = %{http #{req[:method]} '#{HttpFp::to_uri.(req).to_s}' #{req[:header].map(&@@header_to_httpie).join(" ")}}
@@ -15,5 +15,6 @@ module HttpFp::Httpie
     end
   }
   @@header_to_httpie = -> a {
-   "\\\n    '#{a[0]}: #{a[1]}'"}
+    "\\\n    '#{a[0]}: #{a[1]}'"
+  }
 end

data/lib/http_fp/operators.rb

@@ -1,4 +1,4 @@
-require 'superators19'
+require "superators19"
 
 class Proc
   superator ">>~" do |fn|
@@ -11,5 +11,3 @@ class Object
     fn.(self)
   end
 end
-
-

data/lib/http_fp/rack.rb

@@ -1,52 +1,53 @@
-require 'http_fp'
-require 'active_support'
-require 'pp'
+require "http_fp"
+require "pp"
 #
 # https://www.diffchecker.com/ihCGIKyG
 
 module HttpFp::Rack
-  mattr_reader :to_env, :server, :rack_resp_to_resp
+  fn_reader :to_env, :server, :rack_resp_to_resp
 
-  @@server = -> rack { to_env >>~ rack.method(:call) >>~ rack_resp_to_resp }
+  @@server = -> rack { to_env >> rack.method(:call) >> rack_resp_to_resp }
   @@to_env = -> request {
     session ||= {}
     session_options ||= {}
 
-    uri = request >>+ HttpFp.to_uri 
+    uri = request.then(&HttpFp.to_uri)
     header = (request[:header] || {}).dup
-    body = request[:body] || ''
+    body = request[:body] || ""
 
-    content_type_key, val = header.detect { |key, val| puts key; key.downcase == "content-type"}
+    content_type_key, val = header.detect { |key, val| puts key; key.downcase == "content-type" }
     env = {
       # CGI variables specified by Rack
-      'REQUEST_METHOD' => request[:method].to_s.upcase,
-      'CONTENT_TYPE'   => header.delete(content_type_key),
-      'CONTENT_LENGTH' => body.bytesize,
-      'PATH_INFO'      => uri.path,
-      'QUERY_STRING'   => uri.query || '',
-      'SERVER_NAME'    => uri.host,
-      'SERVER_PORT'    => uri.port,
-      'SCRIPT_NAME'    => ""
+      "REQUEST_METHOD" => request[:method].to_s.upcase,
+      "CONTENT_TYPE" => header.delete(content_type_key),
+      "CONTENT_LENGTH" => body.bytesize,
+      "PATH_INFO" => uri.path,
+      "QUERY_STRING" => uri.query || "",
+      "SERVER_NAME" => uri.host,
+      "SERVER_PORT" => uri.port,
+      "SCRIPT_NAME" => "",
     }
 
-    env['HTTP_AUTHORIZATION'] = 'Basic ' + [uri.userinfo].pack('m').delete("\r\n") if uri.userinfo
+    env["HTTP_AUTHORIZATION"] = "Basic " + [uri.userinfo].pack("m").delete("\r\n") if uri.userinfo
 
     # Rack-specific variables
-    env['rack.input']      = StringIO.new(body)
-    env['rack.errors']     = $stderr
-    env['rack.version']    = ::Rack::VERSION
-    env['rack.url_scheme'] = uri.scheme
-    env['rack.run_once']   = true
-    env['rack.session']    = session
-    env['rack.session.options'] = session_options
-
-    header.each { |k, v| env["HTTP_#{k.tr('-','_').upcase}"] = v }
+    env["rack.input"] = StringIO.new(body)
+    env["rack.errors"] = $stderr
+    env["rack.version"] = ::Rack::VERSION
+    env["rack.url_scheme"] = uri.scheme
+    env["rack.run_once"] = true
+    env["rack.session"] = session
+    env["rack.session.options"] = session_options
+
+    header.each { |k, v| env["HTTP_#{k.tr("-", "_").upcase}"] = v }
     env
   }
 
-  @@rack_resp_to_resp = -> resp { {status: resp[0], 
-                                   header: resp[1], 
-                                   body: @@body_from_rack_response.(resp[2])} }
+  @@rack_resp_to_resp = -> resp {
+    { status: resp[0],
+     header: resp[1],
+     body: @@body_from_rack_response.(resp[2]) }
+  }
 
   @@body_from_rack_response = -> response {
     body = ""

data/lib/http_fp/utils.rb

@@ -1,20 +1,18 @@
-require 'active_support'
-require 'json'
-require 'pp'
-require 'http_fp/operators'
-require 'yaml'
+require "json"
+require "pp"
+require "yaml"
 
 module Utils
-  mattr_accessor :parse_json, :debug, :at, :retry_fn, 
-    :record, :player, :count_by, :cache, :red, :time, 
+  fn_reader :parse_json, :debug, :at, :retry_fn,
+    :record, :player, :count_by, :cache, :red, :time,
     :expired, :apply, :and_then, :default, :map, :get, :try
 
   @@parse_json = JSON.method(:parse)
-  @@debug = -> print, a, b { print.(a) ; print.(b.to_s); b }.curry
+  @@debug = -> print, a, b { print.(a); print.(b.to_s); b }.curry
   @@at = -> key, hash { hash[key] }.curry
   @@red = -> a { "\033[31m#{a}\033[0m" }
   # ( a -> b ) -> a -> b
-  @@try = -> f, a { a.nil? ?  nil : f.(a) }.curry
+  @@try = -> f, a { a.nil? ? nil : f.(a) }.curry
   @@retry_fn = -> fn, a {
     begin
       fn.(a)
@@ -30,33 +28,34 @@ module Utils
   }.curry
   @@play = -> filename, _params { YAML.load(File.read(filename)) }.curry
   # (Float -> String -> Bool) -> String -> (a -> b) -> b
-  @@cache  = -> expired, filename, fn, param {
-    if expired.(filename) 
+  @@cache = -> expired, filename, fn, param {
+    if expired.(filename)
       @@record.(filename).(fn.(param))
     else
       puts "reading from cache"
       @@play.(filename).(nil)
     end
   }.curry
-  @@expired = -> sec, a { ! File.exist?(a)  || (Time.now - File.mtime(a)) > sec  }.curry
-  @@count_by = -> fn, a { 
-    a.inject({}) do |res, a| 
+  @@expired = -> sec, a { !File.exist?(a) || (Time.now - File.mtime(a)) > sec }.curry
+  @@count_by = -> fn, a {
+    a.inject({}) do |res, a|
       by = fn.(a)
       res[by] ||= 0
       res[by] += 1
       res
     end
   }.curry
-  
+
   # (String -> String) -> String -> ( a -> b ) -> a -> b
   @@time = -> print, msg, fn, a {
-    start_time = Time.now 
+    start_time = Time.now
     res = fn.(a)
     print.("Time duration for #{msg} =  #{Time.now - start_time}")
-    res}.curry
+    res
+  }.curry
   @@apply = -> method, a { a.send(method) }.curry
   @@default = -> default, a { a.nil? ? default : a }.curry
-  @@and_then = -> f , a { a.nil? ? nil : f.(a) }.curry
+  @@and_then = -> f, a { a.nil? ? nil : f.(a) }.curry
   @@map = -> f, enum { enum.map(&f) }.curry
   @@at = -> key, hash { hash; hash[key] }.curry
   @@get = -> method, obj { obj.send(method) }.curry

data/lib/http_fp/version.rb

@@ -1,3 +1,3 @@
 module HttpFp
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/test/http_fp/httpie_test.rb

@@ -1,18 +1,18 @@
-require 'minitest_helper'
-require 'http_fp'
-require 'http_fp/rack'
-require 'http_fp/httpie'
+require "minitest_helper"
+require "http_fp"
+require "http_fp/rack"
+require "http_fp/httpie"
 
 class HttpFp::CurlTest < Minitest::Test
   include HttpFp
 
-  def setup 
-    @curl = verb.("GET") >>~ 
-      with_path.("/coucou") >>~ 
-      with_headers.(json_headers) >>~ 
-      with_host.("https://api.github.com") >>~ 
-      with_json.({user: "martin"}) >>~
-      HttpFp::Httpie.req >>+ run_
+  def setup
+    @curl = (verb.("GET") >>
+             with_path.("/coucou") >>
+             with_headers.(json_headers) >>
+             with_host.("https://api.github.com") >>
+             with_json.({ user: "martin" }) >>
+             HttpFp::Httpie.req).(empty_req)
   end
 
   def test_should_return_a_curl_command

data/test/http_fp/rack_test.rb

@@ -1,6 +1,6 @@
-require 'minitest_helper'
-require 'rack'
-require 'http_fp/rack'
+require "minitest_helper"
+require "rack"
+require "http_fp/rack"
 
 # https://github.com/macournoyer/thin/blob/a7d1174f47a4491a15b505407c0501cdc8d8d12c/spec/request/parser_spec.rb
 # rack sample
@@ -9,36 +9,27 @@ class HttpFp::RackTest < MiniTest::Test
   include HttpFp
 
   def setup
-    @req = HttpFp.empty_req >>+ with_host.("http://localhost:3000")
+    @req = HttpFp.empty_req.then(&with_host.("http://localhost:3000"))
   end
 
   def test_upcase_headers
-    req = @req >>+ add_headers.("X-invisible" => "tata")
+    req = @req.then(&add_headers.("X-invisible" => "tata"))
     env = Rack.to_env.(req)
-    assert_equal "tata",  env["HTTP_X_INVISIBLE"]
+    assert_equal "tata", env["HTTP_X_INVISIBLE"]
   end
 
   def test_basic_headers
-    env = empty_req >>+ verb.("get") >>+
-      with_host.("https://localhost:3000") >>+
-      with_query.({"name" => "martin"}) >>+
-      with_path.("/users/1") >>+ 
-      Rack.to_env
+    env = empty_req.then(&(verb.("get") >> with_host.("https://localhost:3000") >> with_query.({ "name" => "martin" }) >> with_path.("/users/1") >> Rack.to_env))
     # assert_equal "HTTP/1.1", env["SERVER_PROTOCOL"]
     # assert_equal "HTTP/1.1", env["HTTP_VERSION"]
     # assert_equal "/users/1", env["REQUEST_PATH"]
     assert_equal "GET", env["REQUEST_METHOD"]
-    assert_equal 'https', env["rack.url_scheme"]
-    assert_equal '/users/1', env["PATH_INFO"]
+    assert_equal "https", env["rack.url_scheme"]
+    assert_equal "/users/1", env["PATH_INFO"]
   end
 
   def test_host
-    env = empty_req >>+ 
-      verb.("get") >>+ 
-      with_host.("https://localhost:3000") >>+ 
-      with_query.({"name" => "martin"}) >>+
-      with_path.("/users/1") >>+ 
-      Rack.to_env
+    env = empty_req.then(&(verb.("get") >> with_host.("https://localhost:3000") >> with_query.({ "name" => "martin" }) >> with_path.("/users/1") >> Rack.to_env))
     # assert_equal "localhost:3000", env["HTTP_HOST"]
     assert_equal "localhost", env["SERVER_NAME"]
     assert_equal 3000, env["SERVER_PORT"]
@@ -47,15 +38,8 @@ class HttpFp::RackTest < MiniTest::Test
   end
 
   def test_dont_prepend_HTTP_to_content_type_and_content_length
-    env = empty_req >>+ 
-      verb.("get") >>+ 
-      with_host.("https://localhost:3000") >>+ 
-      with_query.({"name" => "martin"}) >>+
-      with_path.("/users/1") >>+ 
-      add_headers.({"content-type" => "application/json"}) >>+ 
-      Rack.to_env
+    env = empty_req.then(&(verb.("get") >> with_host.("https://localhost:3000") >> with_query.({ "name" => "martin" }) >> with_path.("/users/1") >> add_headers.({ "content-type" => "application/json" }) >> Rack.to_env))
     assert_equal "application/json", env["CONTENT_TYPE"]
     assert_equal 0, env["CONTENT_LENGTH"]
   end
 end
-

data/test/http_fp_test.rb

@@ -1,14 +1,13 @@
-require 'minitest_helper'
-require 'http_fp'
+require "minitest_helper"
+require "http_fp"
 
 class HttpFp::HttpFpTest < Minitest::Test
   include HttpFp
 
   def test_basic_auth
-    req = empty_req >>+ with_basic_auth.("martin").("secret")
+    req = with_basic_auth.("martin").("secret").(empty_req)
     authorization = req[:header]["Authorization"]
     refute_nil authorization
     assert_equal "Basic bWFydGluOnNlY3JldA==", authorization
   end
 end
-

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: http_fp
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Martin Chabot
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-09 00:00:00.000000000 Z
+date: 2019-02-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -67,21 +67,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: activesupport
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: superators19
+  name: fn_reader
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -144,8 +130,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.10
+rubygems_version: 3.0.1
 signing_key: 
 specification_version: 4
 summary: Http client that levrage the use of fp principle