haveapi 0.7.1 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 991d9ac5afd57c72c1a850a0cfd1be12f60d1377
-  data.tar.gz: 3e35451ef4229e6392e0321186138f52052ba043
+  metadata.gz: 0a2561065ed9bd8e8a053e8efa3debcc9629ce6d
+  data.tar.gz: eaf9113c05194d96329c23a40953bee900757110
 SHA512:
-  metadata.gz: 440fc05dda89aafbc3185605a9529de1ee1e2f641aa9465d6816baac3060d7588a7da8a757f38c4ff3cdde709b0ae432fd1361744ecdd51eefe5ca359c14e1e7
-  data.tar.gz: 4a201223cf2a37a61de53c90d296599857e3855de802c16bfcff3b9c417522a81ee9717ddc21ecd39cb0a78336cdb6e64d41e6006ee54dc3a743e8cd7d35fd88
+  metadata.gz: 3d04c0295dd93b9b7c4f7f094106c087a83a5e734c425e50c33f8d1bb03e4e9dce4eb8d9995760e6755b8177f62a63af3a96be362e7ab80f6db67c4606249815
+  data.tar.gz: da12b6b30fb5978e2e0627c0ffbc2ce7d53395a665d7d23008f20459a5d1342db5643f0342857a21c56c4e9f2e561a89c990313d1261ad7ca9d0894aa3e02a7a

data/CHANGELOG

@@ -1,3 +1,12 @@
+* Fri Feb 10 2017 - version 0.8.0
+- Protocol version 1.2
+- Server.base_url: support for proxied https
+- Fix typos and scoping in Spec::ApiBuilder
+- Typed parameters can be set as protected, i.e. their values are to be
+  visually hidden (like passwords)
+- ActiveRecord adapter: resolve URL parameters for objects returned by the Index
+  action using the Show action as a fallback
+
 * Fri Nov 25 2016 - version 0.7.1
 - Require haveapi-client 0.7.0
 

data/README.md

@@ -30,8 +30,6 @@ At the moment, the following clients are available:
 - PHP client: https://github.com/vpsfreecz/haveapi-client-php
 - JavaScript client: https://github.com/vpsfreecz/haveapi-client-js
 
-If there isn't a client in the language you need, you can [create it](doc/create-client.md).
-
 Complex applications can be built on top of these basic clients, e.g.:
 
 - [haveapi-webui](https://github.com/vpsfreecz/haveapi-webui), a generic web administration
@@ -39,6 +37,9 @@ Complex applications can be built on top of these basic clients, e.g.:
 - [haveapi-fs](https://github.com/vpsfreecz/haveapi-fs), a FUSE based filesystem that can
   mount any HaveAPI-based API
 
+If there isn't a client in the language you need, you can [create it](doc/create-client.md)
+and then use it for all HaveAPI-based APIs.
+
 ## Protocol features
 - Creates RESTful APIs usable even with simple HTTP client, should it be needed
 - A change in the API is immediately reflected in all clients when they re-download the
@@ -300,6 +301,8 @@ or cancel their execution.
 ## Read more
  - [Protocol definition](doc/protocol.md)
  - [How to create a client](doc/create-client.md)
+ - [Project templates](https://github.com/vpsfreecz/haveapi-server-project-templates)
+ - [API examples](https://github.com/vpsfreecz/haveapi-server-examples)
 
 ## Contributing
 

data/doc/json-schema.erb

@@ -137,7 +137,8 @@ DEFINITIONS = {
                                         enum: %w(String Text Integer Float Datetime Boolean)
                                     },
                                     validators: { '$ref' => '#/definitions/input_validators' },
-                                    default: {}
+                                    default: {},
+                                    protected: { type: :boolean },
                                 }
                             },
                             {
@@ -176,8 +177,11 @@ DEFINITIONS = {
                     }
                 }
             },
-            layout: {},
-            namespace: {}
+            layout: {
+                type: :string,
+                enum: %w(hash hash_list object object_list),
+            },
+            namespace: { type: :string }
         }
     },
 
@@ -281,9 +285,65 @@ DEFINITIONS = {
     output_parameters: {
         type: :object,
         properties: {
-          parameters: {},
-          layout: {},
-          namespace: {}
+            parameters: {
+                type: :object,
+                patternProperties: {
+                    '^[a-z_]+$' => {
+                        type: :object,
+                        oneOf: [
+                            {
+                                title: 'Data type',
+                                type: :object,
+                                properties: {
+                                    label: { type: :string },
+                                    description: { type: :string },
+                                    type: {
+                                        type: :string,
+                                        enum: %w(String Text Integer Float Datetime Boolean)
+                                    },
+                                    protected: { type: :boolean },
+                                }
+                            },
+                            {
+                                title: 'Resource',
+                                type: :object,
+                                properties: {
+                                    label: { type: :string },
+                                    description: { type: :string },
+                                    type: {
+                                        type: :string,
+                                        enum: %w(Resource)
+                                    },
+                                    resource: { type: :array },
+                                    value_id: { type: :string },
+                                    value_label: { type: :string },
+                                    value: {
+                                        type: :object,
+                                        properties: {
+                                            url: { type: :string },
+                                            method: { type: :string },
+                                            help: { type: :string },
+                                        }
+                                    },
+                                    choices: {
+                                        type: :object,
+                                        properties: {
+                                            url: { type: :string },
+                                            method: { type: :string },
+                                            help: { type: :string },
+                                        }
+                                    }
+                                }
+                            }
+                        ]
+                    }
+                }
+            },
+            layout: {
+                type: :string,
+                enum: %w(hash hash_list object object_list),
+            },
+            namespace: { type: :string },
         }
     },
 

data/doc/protocol.md

@@ -227,7 +227,8 @@ The type can be one of:
             "description": "Describe it's meaning",
             "type": "<one of the data types>",
             "validators": ... validators ...,
-            "default": "default value that is used if the parameter is omitted"
+            "default": "default value that is used if the parameter is omitted",
+            "protected": true/false
         }
 
 

data/haveapi.gemspec

@@ -5,7 +5,7 @@ require 'haveapi/version'
 Gem::Specification.new do |s|
   s.name        = 'haveapi'
   s.version     = HaveAPI::VERSION
-  s.date        = '2016-11-25'
+  s.date        = '2017-02-10'
   s.summary     =
   s.description = 'Framework for creating self-describing APIs'
   s.authors     = 'Jakub Skokan'
@@ -24,6 +24,6 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency 'rake'
   s.add_runtime_dependency 'github-markdown', '~> 0.6.9'
   s.add_runtime_dependency 'nesty', '~> 1.0.2'
-  s.add_runtime_dependency 'haveapi-client', '~> 0.7.1'
+  s.add_runtime_dependency 'haveapi-client', '~> 0.8.0'
   s.add_runtime_dependency 'mail'
 end

data/lib/haveapi/action.rb

@@ -4,7 +4,7 @@ module HaveAPI
     has_attr :version
     has_attr :desc
     has_attr :route
-    has_attr :resolve, ->(klass){ klass.respond_to?(:id) ? klass.id : nil }
+    has_attr :resolve
     has_attr :http_method, :get
     has_attr :auth, true
     has_attr :aliases, []
@@ -240,6 +240,15 @@ module HaveAPI
 
         ret
       end
+
+      def resolve_url_params(object)
+        if self.resolve
+          self.resolve.call(object)
+
+        else
+          object.respond_to?(:id) ? object.id : nil
+        end
+      end
     end
 
     def initialize(request, version, params, body, context)

data/lib/haveapi/authentication/token/resources.rb

@@ -14,7 +14,7 @@ module HaveAPI::Authentication::Token
 
         input(:hash) do
           string :login, label: 'Login', required: true
-          string :password, label: 'Password', required: true
+          password :password, label: 'Password', required: true
           string :lifetime, label: 'Lifetime', required: true,
                   choices: %i(fixed renewable_manual renewable_auto permanent),
                   desc: <<END

data/lib/haveapi/context.rb

@@ -61,7 +61,7 @@ module HaveAPI
     end
 
     def call_url_params(action, obj)
-      ret = params && action.resolve.call(obj)
+      ret = params && action.resolve_url_params(obj)
 
       return [ret] if ret && !ret.is_a?(Array)
       ret

data/lib/haveapi/model_adapters/active_record.rb

@@ -165,7 +165,16 @@ END
       end
 
       def meta
-        params = @context.action.resolve.call(@object)
+        res = @context.action.resource
+
+        if @context.action.name.demodulize == 'Index' \
+           && !@context.action.resolve \
+           && res.const_defined?(:Show)
+          params = res::Show.resolve_url_params(@object)
+
+        else
+          params = @context.action.resolve_url_params(@object)
+        end
 
         {
             url_params: params.is_a?(Array) ? params : [params],
@@ -184,7 +193,7 @@ END
         res_show = param.show_action
         res_output = res_show.output
 
-        args = res_show.resolve.call(val)
+        args = res_show.resolve_url_params(val)
 
         if includes_include?(param.name)
           push_cls = @context.action
@@ -307,7 +316,7 @@ END
       # handle ::ActiveRecord::Validations::PresenceValidator do |v|
       #   opts = { empty: false }
       #   opts[:message] = v.options[:message] if v.options[:message]
-      # 
+      #
       #   validator(HaveAPI::Validators::Presence, :present, opts)
       # end
 
@@ -350,15 +359,15 @@ END
 
       handle ::ActiveModel::Validations::NumericalityValidator do |v|
         opts = {}
-        
+
         opts[:min] = v.options[:greater_than] + 1 if v.options[:greater_than]
         opts[:min] = v.options[:greater_than_or_equal_to] if v.options[:greater_than_or_equal_to]
-        
+
         if v.options[:equal_to]
           validator(accept: v.options[:equal_to])
           next
         end
-        
+
         opts[:max] = v.options[:less_than] - 1 if v.options[:less_than]
         opts[:max] = v.options[:less_than_or_equal_to] if v.options[:less_than_or_equal_to]
 

data/lib/haveapi/parameters/typed.rb

@@ -2,7 +2,7 @@ require 'date'
 
 module HaveAPI::Parameters
   class Typed
-    ATTRIBUTES = %i(label desc type db_name default fill clean)
+    ATTRIBUTES = %i(label desc type db_name default fill clean protected)
 
     attr_reader :name, :label, :desc, :type, :default
 
@@ -47,7 +47,8 @@ module HaveAPI::Parameters
           description: @desc,
           type: @type ? @type.to_s : String.to_s,
           validators: @validators ? @validators.describe : {},
-          default: @default
+          default: @default,
+          protected: @protected || false,
       }
     end
 

data/lib/haveapi/params.rb

@@ -94,6 +94,10 @@ module HaveAPI
       add_param(*apply(args, type: Text))
     end
 
+    def password(*args)
+      add_param(*apply(args, type: String, protected: true))
+    end
+
     def id(*args)
       integer(*args)
     end
@@ -218,7 +222,7 @@ module HaveAPI
     # convert params to correct data types, set default values if necessary.
     def validate(params)
       errors = {}
-     
+
       layout_aware(params) do |input|
         # First run - coerce values to correct types
         @params.each do |p|
@@ -226,7 +230,7 @@ module HaveAPI
             errors[p.name] = ['required parameter missing']
             next
           end
-          
+
           unless input.has_key?(p.name)
             input[p.name] = p.default if p.respond_to?(:fill?) && p.fill?
             next
@@ -240,24 +244,24 @@ module HaveAPI
             errors[p.name] << e.message
             next
           end
-          
+
           input[p.name] = cleaned if cleaned != :_nil
         end
-        
+
         # Second run - validate parameters
         @params.each do |p|
           next if errors.has_key?(p.name)
           next if input[p.name].nil?
 
           res = p.validate(input[p.name], input)
-          
+
           unless res === true
             errors[p.name] ||= []
             errors[p.name].concat(res)
           end
         end
       end
-      
+
       unless errors.empty?
         raise ValidationError.new('input parameters not valid', errors)
       end

data/lib/haveapi/server.rb

@@ -88,7 +88,14 @@ module HaveAPI
       end
 
       def base_url
-        "#{request.env['rack.url_scheme']}://#{request.env['HTTP_HOST']}"
+        if request.env['HTTP_X_FORWARDED_SSL'] == 'on'
+          scheme = 'https'
+
+        else
+          scheme = request.env['rack.url_scheme']
+        end
+
+        "#{scheme}://#{request.env['HTTP_HOST']}"
       end
 
       def host

data/lib/haveapi/spec/api_builder.rb

@@ -40,7 +40,7 @@ module HaveAPI::Spec
     # Select API versions to be used.
     def use_version(v)
       before(:each) do
-        opts(:versions, v)
+        self.class.opt(:versions, v)
       end
     end
 
@@ -51,7 +51,7 @@ module HaveAPI::Spec
 
     # Set a custom mount path.
     def mount_to(path)
-      opts(:mount, path)
+      opt(:mount, path)
     end
 
     # Login using HTTP basic.

data/lib/haveapi/version.rb

@@ -1,4 +1,4 @@
 module HaveAPI
-  PROTOCOL_VERSION = '1.1'
-  VERSION = '0.7.1'
+  PROTOCOL_VERSION = '1.2'
+  VERSION = '0.8.0'
 end

data/spec/parameters/typed_spec.rb

@@ -43,10 +43,10 @@ describe 'Parameters::Typed' do
   it 'can be optional' do
     p = p_arg
     expect(p.optional?).to be true
-    
+
     p = p_arg(required: false)
     expect(p.optional?).to be true
-    
+
     p = p_arg(required: nil)
     expect(p.optional?).to be true
   end
@@ -55,7 +55,7 @@ describe 'Parameters::Typed' do
     # Integer
     p = p_type(Integer)
     expect(p.clean('42')).to eq(42)
-    
+
     # Float
     p = p_type(Float)
     expect(p.clean('3.1456')).to eq(3.1456)
@@ -66,7 +66,7 @@ describe 'Parameters::Typed' do
     %w(true t yes y 1).each do |v|
       expect(p.clean(v)).to be true
     end
-    
+
     %w(false f no n 0).each do |v|
       expect(p.clean(v)).to be false
     end
@@ -90,4 +90,17 @@ describe 'Parameters::Typed' do
     p.patch(default: 'bazinga')
     expect(p.clean(nil)).to eq('bazinga')
   end
+
+  it 'can be protected' do
+    p = p_arg(protected: true)
+    expect(p.describe(nil)[:protected]).to be true
+
+    p = p_arg(protected: false)
+    expect(p.describe(nil)[:protected]).to be false
+  end
+
+  it 'is unprotected by default' do
+    p = p_arg
+    expect(p.describe(nil)[:protected]).to be false
+  end
 end

data/spec/params_spec.rb

@@ -8,7 +8,7 @@ describe HaveAPI::Params do
     class Index < HaveAPI::Actions::Default::Index
 
     end
-    
+
     class Show < HaveAPI::Actions::Default::Show
       output do
         string :not_label
@@ -19,7 +19,7 @@ describe HaveAPI::Params do
 
     end
   end
-  
+
   it 'executes all blocks' do
     p = HaveAPI::Params.new(:input, MyResource::Index)
     p.add_block Proc.new { string :param1 }
@@ -134,8 +134,8 @@ describe HaveAPI::Params do
     p.exec
     p.patch(:param1, label: 'Better param 1')
     p.patch(:param2, desc: 'Better description')
-    expect(p.params.first.label).to eq('Better param 1')
-    expect(p.params.second.desc).to eq('Better description')
+    expect(p.params[0].label).to eq('Better param 1')
+    expect(p.params[1].desc).to eq('Better description')
   end
 
   it 'validates upon build' do
@@ -183,7 +183,7 @@ describe HaveAPI::Params do
       string :param2
     end)
     p.exec
-    
+
     expect(p[:param1]).to eq(p.params[0])
     expect(p[:param2]).to eq(p.params[1])
   end

metadata

@@ -1,167 +1,167 @@
 --- !ruby/object:Gem::Specification
 name: haveapi
 version: !ruby/object:Gem::Version
-  version: 0.7.1
+  version: 0.8.0
 platform: ruby
 authors:
 - Jakub Skokan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-25 00:00:00.000000000 Z
+date: 2017-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: require_all
   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: json
   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: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 4.1.14
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 4.1.14
 - !ruby/object:Gem::Dependency
   name: sinatra
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.4.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.4.6
 - !ruby/object:Gem::Dependency
   name: tilt
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.4.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.4.1
 - !ruby/object:Gem::Dependency
   name: redcarpet
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 3.3.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 3.3.4
 - !ruby/object:Gem::Dependency
   name: rake
   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: github-markdown
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.6.9
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.6.9
 - !ruby/object:Gem::Dependency
   name: nesty
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.0.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.0.2
 - !ruby/object:Gem::Dependency
   name: haveapi-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.1
+        version: 0.8.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.1
+        version: 0.8.0
 - !ruby/object:Gem::Dependency
   name: mail
   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: Framework for creating self-describing APIs
@@ -170,8 +170,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .editorconfig
-- .gitignore
+- ".editorconfig"
+- ".gitignore"
 - CHANGELOG
 - Gemfile
 - LICENSE.txt
@@ -293,12 +293,12 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []