praxis 0.0.1 → 0.9

data/spec/spec_app/design/media_types/volume_snapshot.rb

@@ -0,0 +1,38 @@
+class VolumeSnapshot < Praxis::MediaType
+  identifier 'application/json'
+
+  attributes do
+    attribute :id, Integer
+    attribute :name, String, regexp: /snapshot-(\w+)/
+  end
+
+  view :default do
+    attribute :id
+    attribute :name
+  end
+
+  view :link do
+    attribute :id
+  end
+
+
+  class Collection < Praxis::MediaTypeCollection
+    identifier 'application/json+collection'
+
+    member_type VolumeSnapshot
+
+    attributes do
+      attribute :name, String, regexp: /snapshots-(\w+)/
+      attribute :size, Integer, example: proc { |collection| collection.to_a.count }
+      attribute :href, String
+    end
+
+    view :link do
+      attribute :name
+      attribute :size
+      attribute :href
+    end
+
+  end
+
+end

data/spec/spec_app/design/resources/instances.rb

@@ -0,0 +1,161 @@
+module ApiResources
+  class Instances
+    include Praxis::ResourceDefinition
+
+    media_type Instance
+    version '1.0'
+
+    #response_groups :premium
+    #responses :instance_limit_reached
+    #responses :pay_us_money
+    #response :create, location: /instances/
+
+    use :authenticated
+
+    routing do
+      prefix '/clouds/:cloud_id/instances'
+    end
+
+    params do
+      attribute :cloud_id, Integer, required: true
+    end
+
+    action :index do
+      routing do
+        get ''
+      end
+
+      response_content_type = self.resource_definition.media_type.identifier + ";type=collection"
+      params do
+        attribute :response_content_type, String, default: response_content_type
+      end
+
+      response :ok, media_type: response_content_type
+    end
+
+    action :show do
+      routing do
+        get '/:id'
+        get '/something/:id', name: :alternate
+      end
+
+      response :ok
+
+      params do
+        attribute :id
+        attribute :junk, String, default: ''
+        attribute :some_date, DateTime, default: DateTime.parse('2012-12-21')
+      end
+      payload do
+        attribute :something, String
+        attribute :optional, String, default: "not given"
+      end
+    end
+
+
+    action :bulk_create do
+      routing do
+        post ''
+      end
+
+      payload Praxis::Multipart.of(key: Integer, value: Instance)
+
+      # Using a hash param for parts
+      response :bulk_response ,
+                parts: {
+                  like: :created,
+                  media_type: Instance # Could be left blank and will inherit
+                }
+
+# Using a block for parts to defin a sub-request
+#     sub_request = proc do
+#                     status 201
+#                     media_type Instance
+#                     headers ['X-Foo','X-Bar']
+#                   end
+#     response :bulk_response, parts: sub_request
+
+
+      # multi 200, H1
+      # parts_as :resp1
+
+      # part_type do
+      #   201
+      #   h Location ~= /asdfa/
+      # end
+
+      # part 'dest_dir' do
+
+      # end
+      # part 'file' do
+      #   mt binary
+      # end
+    end
+
+    #action :get_user_data do
+    #  response :get_user_data do
+    #    media_type: UserData
+    #  end
+    #end
+
+    action :attach_file do
+      routing do
+        post '/:id/files'
+      end
+
+      params do
+        attribute :id
+      end
+
+      payload Praxis::Multipart do
+        key 'destination_path', String, required: true
+        key 'file', Attributor::FileUpload, required: true
+      end
+
+      response :ok, media_type: 'application/json'
+    end
+
+
+    # OTHER USAGES:
+    #   note: these are all hypothetical, pending, brainstorming usages.
+
+    # given: single file, super simple upload, with count constraint
+    # result: only one part is accepted
+    # example:
+    #   payload Praxis::Multipart.of(FileUpload), count: 1
+
+    # given: multiple file uploads
+    # example:
+    #   payload Praxis::Multipart.of(key: UUID, value: Attributor::FileUpload)
+
+    # given: any untyped multipart request body
+    # example:
+    #  payload Praxis::Multipart
+
+    # given: single known key, plus multiple uploaded files which can take any name
+    # result: multiple files collected into a single Hash.of(value: FileUpload)
+    # example:
+    #   payload Praxis::Multipart do
+    #     key 'destination', String, required: true
+    #     splat 'remaining', Hash.of(value: FileUpload)
+    #   end
+
+    # given: single known key, plus multiple uploaded files which can take any name
+    # result: file parts coerced to FileUpload
+    # example:
+    #   payload Praxis::Multipart do
+    #     key 'destination', String, required: true
+    #     other_keys FileUpload
+    #   end
+
+    # given: single known key, plus multiple uploaded files, with names like 'file-'
+    # result: file parts coerced to FileUpload
+    # example:
+    #   payload Praxis::Multipart do
+    #     key 'destination', String, required: true
+    #     match /file-.+/, FileUpload
+    #   end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,39 @@
+$:.unshift File.expand_path(__dir__)
+$:.unshift File.expand_path('../lib',__dir__)
+$:.unshift File.expand_path('support',__dir__)
+
+require 'bundler'
+Bundler.setup :default, :test
+
+require 'simplecov'
+SimpleCov.start 'praxis'
+
+require 'praxis'
+
+require 'rack/test'
+
+require 'rspec/its'
+require 'rspec/collection_matchers'
+
+require 'pry'
+
+Dir["#{File.dirname(__FILE__)}/support/*.rb"].each do |file|
+  require file
+end
+
+
+RSpec.configure do |config|
+  config.include Rack::Test::Methods
+
+  config.before(:suite) do
+    Praxis::Blueprint.caching_enabled = true
+    Praxis::Application.instance.setup(root:'spec/spec_app')
+  end
+
+  config.before(:each) do
+    Praxis::Blueprint.cache = Hash.new do |hash, key|
+      hash[key] = Hash.new
+    end
+  end
+
+end

data/spec/support/spec_media_types.rb

@@ -0,0 +1,46 @@
+class Person < Praxis::MediaType
+  attributes do 
+    attribute :id, Integer
+    attribute :name, String, example: /[:name:]/
+    attribute :href, String, example: proc { |person| "/people/#{person.id}" }
+  end
+
+  view :default do
+    attribute :id
+    attribute :name
+  end
+
+  view :link do
+    attribute :id
+    attribute :name
+    attribute :href
+  end
+end
+
+
+class Address < Praxis::MediaType
+  identifier 'application/json'
+
+  description 'Address MediaType'
+
+  attributes do
+    attribute :id, Integer
+    attribute :name, String
+
+    attribute :owner, Person
+
+    links do
+      link :owner
+      link :super, Person, using: :manager
+    end
+
+  end
+
+  view :default do
+    attribute :id
+    attribute :name
+    attribute :owner
+
+    attribute :links
+  end
+end

data/spec/support/spec_resource_definitions.rb

@@ -0,0 +1,33 @@
+require_relative 'spec_media_types'
+
+class PeopleResource
+  include Praxis::ResourceDefinition
+
+  description 'People resource'
+
+  media_type Person
+
+  version '1.0'
+
+  routing do
+    prefix "/people"
+  end
+
+  action :index do
+    description 'index description'
+    routing do
+      get ''
+    end
+  end
+
+  action :show do
+    description 'show description'
+    routing do
+      get '/:id'
+    end
+    params do
+      attribute :id, Integer, required: true
+    end
+  end
+
+end

data/tasks/praxis_app_generator.thor

@@ -0,0 +1,307 @@
+# vim: setlocal filetype=ruby:
+
+require 'thor'
+require 'pathname'
+require 'yaml'
+
+# Praxis application generator
+#
+# Generates all files required to run a simple praxis app.
+#
+class PraxisAppGenerator < Thor
+  include Thor::Actions
+
+  attr_reader  :app_name
+
+  namespace 'praxis'
+  desc "generate 'app-name'", "Generates a new PRAXIS application"
+
+  # Generates a new praxis app in the current directory
+  #
+  # @param [String] name
+  #
+  # @return [void]
+  #
+  # @example
+  #   # Using thor task
+  #   > bundle exec thor generate my_test_app
+  #
+  # @example
+  #   # Using 'praxis' file saved into '/usr/bin'
+  #   > praxis generate my_test_app
+  #
+  def generate(app_name)
+    # Fix weird symbols in the app name (if they are)
+    @app_name = app_name.downcase.gsub(/[^a-z0-9_\/.]/, '')
+    # Generate a new app
+    empty_directory path('app')
+    empty_directory path('design')
+    empty_directory path('lib')
+    empty_directory path('spec')
+    generate_config_environment_rb
+    generate_gemfile
+    generate_rakefile
+    generate_config_ru
+    generate_app_definitions_hello_world
+    generate_app_controllers_hello_world
+    #
+    puts
+    puts "To run the example application:"
+    puts
+    puts "  # terminal 1:"
+    puts "  cd #{app_name}"
+    puts "  bundle"
+    puts "  rackup -p 8888"
+    puts
+    puts "  # terminal 2:"
+    puts "  curl -i http://localhost:8888/api/hello   -H 'X-Api-Version: 1.0' -X GET  # Index"
+    puts "  curl -i http://localhost:8888/api/hello/2 -H 'X-Api-Version: 1.0' -X GET  # Show"
+    puts "  curl -i http://localhost:8888/api/hello/2 -H 'X-Api-Version: 2.0' -X GET  # NotFound Error"
+    nil
+  end
+
+
+private
+
+
+  # Returns relative path for the new application
+  #
+  # @return [String]
+  #
+  # @example
+  #  # > /praxis generate My-test_praxisApp
+  #  app_dir_pathname #=> 'mytest_praxisapp'
+  #
+  #
+  def app_dir_pathname
+    @app_dir_pathname ||= Pathname.new(app_name)
+  end
+
+
+  # Returns path string built from the set of the given strings
+  #
+  # @param [String,Array] strings
+  #
+  # @return [String]
+  #
+  # @example
+  #   path('a', 'b', 'c') #=> 'my_test_app/a/b/c'
+  #
+  def path(*strings)
+    app_dir_pathname.join(*strings).to_s
+  end
+
+
+  # Creates './config/environment.rb' file
+  #
+  # @return [void]
+  #
+  def generate_config_environment_rb
+    create_file path('config/environment.rb') do
+<<-RUBY
+# Main entry point - DO NOT MODIFY THIS FILE
+ENV['RACK_ENV'] ||= 'development'
+
+Bundler.require(:default, ENV['RACK_ENV'])
+
+# Default application layout.
+# NOTE: This layout need NOT be specified explicitly.
+# It is provided just for illustration.
+Praxis::Application.instance.layout do
+  map :initializers, 'config/initializers/**/*'
+  map :lib, 'lib/**/*'
+  map :design, 'design/' do
+    map :api, 'api.rb'
+    map :media_types, '**/media_types/**/*'
+    map :resources, '**/resources/**/*'
+  end
+  map :app, 'app/' do
+    map :models, 'models/**/*'
+    map :controllers, '**/controllers/**/*'
+    map :responses, '**/responses/**/*'
+  end
+end
+RUBY
+    end
+    nil
+  end
+
+
+  # Creates './Gemfile' file
+  #
+  # @return [void]
+  #
+  def generate_gemfile
+    create_file path('Gemfile') do
+<<-RUBY
+source 'https://rubygems.org'
+
+gem 'praxis'
+gem 'rack', '~> 1.0'
+gem 'rake'
+
+group :development, :test do
+  gem 'rspec'
+end
+RUBY
+    end
+    nil
+  end
+
+
+  # Creates './Rakefile' file
+  #
+  # @return [void]
+  #
+  def generate_rakefile
+    create_file path('Rakefile') do
+<<-RUBY
+require 'praxis'
+require 'praxis/tasks'
+RUBY
+    end
+    nil
+  end
+
+
+  # Creates './config.ru' file
+  #
+  # @return [void]
+  #
+  def generate_config_ru
+    create_file path('config.ru') do
+<<-RUBY
+#\ -p 8888
+
+require 'bundler/setup'
+require 'praxis'
+
+application = Praxis::Application.instance
+application.logger = Logger.new(STDOUT)
+application.setup
+
+run application
+RUBY
+    end
+    nil
+  end
+
+
+  def generate_app_definitions_hello_world
+    create_file path('design/api.rb') do
+<<-RUBY
+# Use this file to define your response templates and traits.
+#
+# For example, to define a response template:
+#   response_template :custom do |media_type:|
+#     status 200
+#     media_type media_type
+#   end
+Praxis::ApiDefinition.define do
+  trait :versionable do
+    headers do
+      header :X_Api_Version, String, values: ['1.0'], required: true
+    end
+  end
+end
+RUBY
+    end
+
+    create_file path('design/resources/hello.rb') do
+<<-RUBY
+module V1
+  module ApiResources
+    class Hello
+      include Praxis::ResourceDefinition
+
+      media_type V1::MediaTypes::Hello
+      version '1.0'
+
+      routing do
+        prefix '/api/hello'
+      end
+
+      action :index do
+        use :versionable
+
+        routing do
+          get ''
+        end
+        response :ok
+      end
+
+      action :show do
+        use :versionable
+
+        routing do
+          get '/:id'
+        end
+        params do
+          attribute :id, Integer, required: true, min: 0
+        end
+        response :ok
+      end
+    end
+  end
+end
+RUBY
+    end
+
+    create_file path('design/media_types/hello.rb') do
+<<-RUBY
+module V1
+  module MediaTypes
+    class Hello < Praxis::MediaType
+
+      identifier 'application/json'
+
+      attributes do
+        attribute :string, String
+      end
+
+      view :default do
+        attribute :string
+      end
+    end
+  end
+end
+RUBY
+    end
+  end
+
+
+  def generate_app_controllers_hello_world
+      create_file path('app/controllers/hello.rb') do
+<<-RUBY
+module V1
+  class Hello
+    include Praxis::Controller
+
+    implements V1::ApiResources::Hello
+
+    HELLO_WORLD = [ 'Hello world!', 'Привет мир!', 'Hola mundo!', '你好世界!', 'こんにちは世界！' ]
+
+    def index(**params)
+      response.headers['Content-Type'] = 'application/json'
+      response.body = HELLO_WORLD.to_json
+      response
+    end
+
+    def show(id:, **other_params)
+      hello = HELLO_WORLD[id]
+      if hello
+        response.body = { id: id, data: hello }
+      else
+        response.status = 404
+        response.body   = { error: '404: Not found' }
+      end
+      response.headers['Content-Type'] = 'application/json'
+      response
+    end
+  end
+end
+RUBY
+    end
+  end
+
+end