utter 1.0.5 → 1.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 52d762766607a4a8f85b52035ac6fc3b37896c72
-  data.tar.gz: 43702a686975fe137a9660cec6f40a3dbb222010
+  metadata.gz: aaca52bdee87dcd076358931bbb3f331b439b609
+  data.tar.gz: 546fcac5095b7da7c2be234db664503cc04fce3c
 SHA512:
-  metadata.gz: ed05ad63614389de0eff74ee821933a69a87b97bd915cb4ae44327f60650ead7a8905c89401fdf2c63554615c1d1ba74d9e7f13bd808810e96e21c29d3c45629
-  data.tar.gz: 38d38483539ab5416ac87e2ead8730ffaba045a03d7ba0c825d8057b6b385efc185a916f29d38ef5d2ae8b530d54aeccae14fba5a223bc61207851d60721eb65
+  metadata.gz: acb9d767cd45681d665a0407d96c37cdb9019cd23982e772e4e0e1ab3cd1cf9e5971dcedcb7ed8cdef196ccf070469dd86c67645d742f5291a18a6eea5bb7963
+  data.tar.gz: 7707900d5300e69d7e3909fd0ba8a6c1c0552684673a5c163dcc8dbc1f0636c5e1227576de6d61c5c751ab0ea4f9edd96a6f4ad7f2de933c19deaf078b279eef

data/README.md

@@ -3,6 +3,15 @@ Utter
 
 Utter is  microservies framework for building independently deployable services. 
 
+Why Utter
+==========
+Utter loves sinatra! thats why it is built on top of it, but make smart descions to faciliate the building of microservices.
+
+Alternative Frameworks
+=======================
+Utter sees Grape as poluted framework.
+Utter sees Rails as MUST-Avoid framework.
+
 Example:
 ========
 > utter deploy user@serverip

data/examples/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+ruby '2.3.1'
+
+gem 'utter'

data/examples/Gemfile.lock

@@ -0,0 +1,34 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    multi_json (1.12.1)
+    rack (1.6.4)
+    rack-protection (1.5.3)
+      rack
+    sinatra (1.4.7)
+      rack (~> 1.5)
+      rack-protection (~> 1.4)
+      tilt (>= 1.3, < 3)
+    sinatra-cross_origin (0.3.2)
+    sinatra-json (0.1.0)
+      multi_json (~> 1.0)
+      sinatra (~> 1.0)
+    ssd (0.1.4)
+    tilt (2.0.5)
+    utter (1.0.5)
+      sinatra
+      sinatra-cross_origin
+      sinatra-json
+      ssd
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  utter
+
+RUBY VERSION
+   ruby 2.3.1p112
+
+BUNDLED WITH
+   1.12.5

data/examples/app.rb

@@ -1,4 +1,6 @@
 require 'utter'
+#require 'rack/show_exceptions'
+
 module API
   module V1
     class PublicEndpoint < Utter::Endpoint

data/examples/config.ru

@@ -1,10 +1,16 @@
 # config.ru (run with rackup)
+##begin
+#  require 'rack/show_exceptions'
+#rescue LoadError
+#  require 'rack/showexceptions'
+#end
+
 require './app'
 
 map('/public') do
-  run PublicEndpoint 
+  run API::V1::PublicEndpoint 
 end
 
 map('/private') do
-  run PrivateEndpoint 
+  run API::V1::PrivateEndpoint 
 end

data/lib/utter/auth.rb

@@ -0,0 +1,74 @@
+#TODO write RDoc
+module Utter
+
+  class Auth < Rack::Auth::Basic
+    def call(env)
+      request = Rack::Request.new(env)
+
+      case request.path when '/docs'
+	@app.call(env)  # skip auth to access documentation
+      else
+	super           # perform auth
+	#TODO use json "sinatra/json" here  to ensure all outcoming response are in json
+
+	#res = Rack::Response.new
+
+	# This will automatically set the Content-Length header for you
+	##res.write "Hello from Rack!"
+
+	# You can get/set headers with square bracket syntax:
+	##res["Content-Type"] = "Content-type: application/json; charset=utf-8"
+
+	# returns the standard [status, headers, body] array
+	##res.finish
+
+	# You can set and delete cookies
+	#   res.set_cookie("user_id", 1)
+	#   res.delete_cookie("user_id"
+      end
+    end
+  end
+
+
+  # Any class that inherits from Endpoint, may include Utter::Token to add security
+  # token, a token can be used for authenticating a signed-in user or as an API for your system.
+  #
+  # Usage
+  # 
+  # via curl https://api.example.com/v1/endpoint_name -u token_value:
+  # via Browser http://token_value@localhost:4567/
+  # If you need to authenticate via bearer auth (e.g., for a cross-origin request), use -H "Authorization: Bearer #{token_value}" instead of -u token_value:
+  #
+  # More Info
+  # - https://en.wikipedia.org/wiki/Digest_access_authentication
+  # - https://github.com/rack/rack/blob/master/lib/rack/auth/basic.rb
+  module Secured
+    def self.included(base)
+      base.class_eval do
+
+	use Auth, "#{self}" do |username, password| 
+
+	  $log.info "username #{username}, password #{username}"
+
+	  if !username.nil? && !password.nil? then
+	    if !User.ssd(username).nil? then
+	      if password == User.ssd(username).password then
+		true # Access Granted
+	      else 
+		false # Access Denied
+	      end
+	    end
+	  end
+	end
+
+	# 404 Error!
+	not_found do
+	  status 404
+	  "404 - Check #{self} API documentation"
+	end
+
+      end
+    end
+  end
+
+end

data/lib/utter/endpoint.rb

@@ -0,0 +1,27 @@
+#TODO write RDoc
+require 'fileutils'
+require 'sinatra'
+require "sinatra/json"
+require 'securerandom'
+require 'sinatra/cross_origin'
+require 'net/http' # Net::HTTP.get('example.com', '/index.html') # => String
+
+module Utter
+  class Endpoint < Sinatra::Base
+    # if cross_origin is required\loaded then make register Sinatra::CrossOrigin 
+    # And 
+    #register Sinatra::CrossOrigin
+
+    #TODO 	set a flag to disable this in production for security
+    #		this helps testing APIs on localmachines as CORS fucks developers time.
+    # 		But not recommended to be set while in production enviroments
+    before do
+      response.headers["Access-Control-Allow-Origin"] = "*"
+      response.headers["Access-Control-Allow-Methods"] = "POST"
+      p response.headers.inspect
+    end
+
+    configure { set :server, :puma }
+
+  end
+end

data/lib/utter/model.rb

@@ -0,0 +1,9 @@
+#TODO write RDoc
+module Utter
+  class Model
+    include Utter::Store 
+    #def self.inherited(model)
+    #  model.send :include, SSD 
+    #end 
+  end
+end

data/lib/utter/store.rb

@@ -0,0 +1,10 @@
+#TODO write RDOC
+require 'ssd'
+
+module Utter
+  module Store
+    def self.included(base)
+      base.send :include, SSD 
+    end 
+  end
+end

data/lib/utter/version.rb

@@ -1,3 +1,3 @@
 module Utter
-  VERSION = "1.0.5"
+  VERSION = "1.0.6"
 end

data/lib/utter.rb

@@ -1,65 +1,13 @@
-require 'fileutils'
 require 'logger'
-require 'sinatra'
-require "sinatra/json"
-require 'securerandom'
-require 'sinatra/cross_origin'
-require 'net/http' # Net::HTTP.get('example.com', '/index.html') # => String
-require 'ssd'
 
-require "utter/version"
+require_relative "utter/version"
+require_relative "utter/store"
+require_relative "utter/model"
+require_relative "utter/endpoint"
+require_relative "utter/auth"
 
-$log = Logger.new(STDOUT)
-
-module Utter
-
-  # any class that inherits from Endpoint, may include Utter::Token to add security
-  # token, a token can be used for authenticating a signed-in user or as an API for your system.
-  #
-  # Usage
-  # 
-  # via curl https://api.example.com/v1/endpoint_name -u token_value:
-  # via Browser http://token_value@localhost:4567/
-  # If you need to authenticate via bearer auth (e.g., for a cross-origin request), use -H "Authorization: Bearer #{token_value}" instead of -u token_value:
-  #
-  # More Info
-  # - https://en.wikipedia.org/wiki/Digest_access_authentication
-  # - https://github.com/rack/rack/blob/master/lib/rack/auth/basic.rb
-  module Token
-    use Rack::Auth::Basic, "Protected Area" do |token|
-      token == 'foo' 
-    end
-  end
-
-  class Endpoint < Sinatra::Base
-    # if cross_origin is required\loaded then make register Sinatra::CrossOrigin 
-    # And 
-    #register Sinatra::CrossOrigin
-
-    #TODO 	set a flag to disable this in production for security
-    #		this helps testing APIs on localmachines as CORS fucks developers time.
-    # 		But not recommended to be set while in production enviroments
-    before do
-      response.headers["Access-Control-Allow-Origin"] = "*"
-      response.headers["Access-Control-Allow-Methods"] = "POST"
-      p response.headers.inspect
-    end
-  end
 
 
-
-  class Model
-    def self.inherited(model)
-      model.send :include, SSD 
-      #model.extend SSD 
-    end 
-  end
-
-  module Store
-    #include SSD
-    def self.included(klass)
-      klass.send :include, SSD 
-    end 
-  end
-
+module Utter
+  $log = Logger.new(STDOUT)
 end

data/utter.gemspec

@@ -42,4 +42,8 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "ssd" 
   spec.add_runtime_dependency "ssd" 
+
+  spec.add_development_dependency "puma" 
+  spec.add_runtime_dependency "puma" 
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: utter
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.0.6
 platform: ruby
 authors:
 - zotherstupidguy
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-09-11 00:00:00.000000000 Z
+date: 2016-09-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -164,6 +164,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: puma
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: puma
+  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'
 description: 
 email:
 - zotherstupidguy@gmail.com
@@ -180,9 +208,15 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- examples/Gemfile
+- examples/Gemfile.lock
 - examples/app.rb
 - examples/config.ru
 - lib/utter.rb
+- lib/utter/auth.rb
+- lib/utter/endpoint.rb
+- lib/utter/model.rb
+- lib/utter/store.rb
 - lib/utter/version.rb
 - utter.gemspec
 homepage: https://github.com/utter-rb