flatpack_client 1.0.pre

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in flatpack_client.gemspec
+gemspec
+
+#gem 'flatpack_core', :git => 'git@github.com:amitrawal/flatpack-core.git'
+#gem "flatpack_core", :path => '/home/amit/projects/themelt/perka_fork/flatpack-core', :group => :development

data/LICENSE.txt

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,17 @@
+# FlatpackClient
+
+FlatpackClient provides request handling support to FlatPack client libraries.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'flatpack_client'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install flatpack_client

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/flatpack_client.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/flatpack/client/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Joe Stelmach"]
+  gem.email         = ["joe@getperka.com"]
+  gem.description   = %q{Write a gem description}
+  gem.summary       = %q{Write a gem summary}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "flatpack_client"
+  gem.require_paths = ["lib"]
+  gem.version       = Flatpack::Client::VERSION
+
+  gem.add_dependency('flatpack_core', '=1.0.pre')
+end

data/lib/flatpack/client/base_api.rb

@@ -0,0 +1,38 @@
+require 'flatpack_core'
+
+module Flatpack
+  module Client
+    class BaseApi
+      include Flatpack::Core::MapInitialize
+      
+      attr_accessor :server_base, :flatpack, :verbose
+      
+      # Concrete implementations that require authentication should implement 
+      # this method do determine if the current session is still active.
+      def session_active?
+        # By default, the session is always active
+        true
+      end
+      
+      # Concrete implementations that require authentication should implement 
+      # this method to refresh an expired session
+      def refresh_session
+      end
+      
+      # Concrete implementations that require authentication should implement 
+      # this method if authenticated requests require custom request headers
+      def auth_headers
+        return {}
+      end
+      
+      def describe_entity_get(entity)
+        describe_type_uuid_get(entity.entity_name, entity.uuid)
+      end
+      
+      def annotation_entity_get(entity)
+        annotation_type_uuid_get(entity.entity_name, entity.uuid)
+      end
+      
+    end
+  end
+end

data/lib/flatpack/client/flatpack_request.rb

@@ -0,0 +1,17 @@
+module Flatpack
+  module Client
+    class FlatpackRequest < Request
+      
+      attr_accessor :entity
+      
+      def process_response(response)
+        @api.flatpack.unpacker.unpack(parse_json(response))
+      end
+      
+      def payload
+        @api.flatpack.packer.pack(@entity)
+      end
+      
+    end
+  end
+end

data/lib/flatpack/client/json_request.rb

@@ -0,0 +1,13 @@
+module Flatpack
+  module Client
+    
+    # A Request that interprets the server response as JSON.
+    class JsonRequest < Request
+      
+      def process_response(response)
+        parse_json(response)
+      end
+      
+    end
+  end
+end

data/lib/flatpack/client/request.rb

@@ -0,0 +1,117 @@
+require 'uri'
+require 'net/https'
+
+module Flatpack
+  module Client
+    class Request
+      
+      attr_accessor :payload
+      
+      def initialize(api, method, path, *args)
+        @api = api
+        @method = method.downcase
+          
+        # replace path paramters
+        @path = path
+        @path.scan(/[{][^}]*[}]/).each_with_index do |match, i|
+          @path.gsub!(match, args[i])
+        end
+        
+        # define default headers
+        @headers = {
+          'Content-Type' => 'application/json'
+        }
+        @headers.merge!(@api.auth_headers)
+        
+        # and query parameters
+        @query_params = {}
+      end
+      
+      # Execute the request.
+      def execute
+        
+        # ensure our api session is still active
+        @api.refresh_session unless @api.session_active?
+        
+        # build our URI
+        uri = URI.parse(@api.server_base.to_s)
+        uri.path = @path
+        unless(@query_params.empty?) 
+          uri.query = @query_params.map{ |key, value| "#{key}=#{URI::encode(value.to_s)}" }.join('&')
+        end
+        
+        # build our request
+        req = Net::HTTP.const_get(@method.capitalize).new(uri.request_uri)
+        payload = self.payload
+        if(payload and payload.length > 0)
+          puts "payload is #{payload}" if @api.verbose
+          req.body = payload 
+        end
+        
+        # add the headers
+        @headers.each do |key, value|
+          req.add_field(key, value)
+        end
+        
+        # log it
+        if(@api.verbose)
+          puts "requesting #{@method} to #{uri.to_s} with headers #{@headers.inspect}"
+        end
+        
+        # and send it off
+        http = Net::HTTP.new(uri.host, uri.port)
+        if(uri.scheme == 'https')
+          # TODO allow the certificate options to be specified 
+          http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+          http.use_ssl = true
+        end
+        response = http.start { |h| h.request(req) }
+          
+        # log our response
+        if(@api.verbose)
+          puts "response #{response.code} with payload #{response.body}"
+        end
+        
+        process_response(response)
+      end
+
+      # Add a custom header to the request.
+      def header(name, value)
+        @headers[name] = value
+        self
+      end
+    
+    # log our response
+      # Add a custom query parameter to the request. The generated subclasses of Request will have
+      # convenience methods for setting defined query parameters.
+      def query_parameter(name, value)
+        @query_params[name] = value
+        self
+      end
+      
+      protected
+      
+      # default response processing simply returns the response
+      def process_response(response)
+        response
+      end
+      
+      # Returns true for a 2XX series response code.
+      def is_ok(code)
+        code >= 200 and code < 300
+      end
+      
+      def parse_json(response)
+        json = {}
+        begin
+          json = JSON.parse(response.body)
+        rescue
+          puts "couldn't parse response as JSON"
+        end
+        json['status_code'] = response.code
+        json
+      end
+      
+    end
+  end
+end

data/lib/flatpack/client/version.rb

@@ -0,0 +1,5 @@
+module Flatpack
+  module Client
+    VERSION = "1.0.pre"
+  end
+end

data/lib/flatpack_client.rb

@@ -0,0 +1,5 @@
+require 'flatpack/client/version'
+require 'flatpack/client/base_api'
+require 'flatpack/client/request'
+require 'flatpack/client/flatpack_request'
+require 'flatpack/client/json_request'

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification 
+name: flatpack_client
+version: !ruby/object:Gem::Version 
+  hash: -632451863
+  prerelease: true
+  segments: 
+  - 1
+  - 0
+  - pre
+  version: 1.0.pre
+platform: ruby
+authors: 
+- Joe Stelmach
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-09-27 00:00:00 +05:30
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: flatpack_core
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: -632451863
+        segments: 
+        - 1
+        - 0
+        - pre
+        version: 1.0.pre
+  type: :runtime
+  version_requirements: *id001
+description: Write a gem description
+email: 
+- joe@getperka.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- flatpack_client.gemspec
+- lib/flatpack/client/base_api.rb
+- lib/flatpack/client/flatpack_request.rb
+- lib/flatpack/client/json_request.rb
+- lib/flatpack/client/request.rb
+- lib/flatpack/client/version.rb
+- lib/flatpack_client.rb
+has_rdoc: true
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      hash: 25
+      segments: 
+      - 1
+      - 3
+      - 1
+      version: 1.3.1
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Write a gem summary
+test_files: []
+