modgen 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in modgen.gemspec
+gemspec
+
+gem 'oauth2'
+gem 'launchy'

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Ondřej Moravčík
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,121 @@
+# Modgen API klient
+
+## Instalation
+
+Install
+
+    gem install modgen
+
+Bundler
+
+    gem 'modgen'
+
+Ruby
+
+    require 'modgen'
+
+
+
+## Configuration
+
+```ruby
+Modgen.configure do
+  client_id "1"
+end
+
+# ------------ or ------------
+
+Modgen.config.client_id = "1"
+```
+
+List of all available conf.
+
+<table>
+  <thead>
+    <tr>
+      <th><b>key</b></th>
+      <th><b>example and description</b></th>
+    </tr>
+  </thead>
+  <tbody>
+    <tr>
+      <td>oauth2.client_id</td>
+      <td>
+        Id of client generated by API server.<br><br>
+
+        <i>e.g. egt45e5t5trh54rth5rth54rt5h4r5t4h5rt4h</i>
+      </td>
+    </tr>
+    <tr>
+      <td>oauth2.client_secret</td>
+      <td>
+        Secret key generated by API server.<br><br>
+
+        <i>e.g. 4546846846th468684684t684hthrthrt6h871rh78888</i>
+      </td>
+    </tr>
+    <tr>
+      <td>oauth2.redirect_uri</td>
+      <td>
+        Address of web page where request will be redirected for gain access code.<br><br>
+
+        <i>e.g http://localhost/oauth2callback</i>
+      </td>
+    </tr>
+  </tbody>
+</table>
+
+
+
+## Usage
+
+First you must discovery API. For displaying all available versions.
+
+
+
+### Discovery
+
+```ruby
+Modgen::Discovery.versions
+```
+
+Details of specific version. If version is nil Modgen show preffered version.
+
+```ruby
+Modgen::Discovery.version(version)
+```
+
+Discover specific version. If version is nil Modgen discover preffered version.
+
+```ruby
+Modgen::Discovery.discover(version)
+```
+
+
+
+### API details
+
+```ruby
+Modgen::API.api.name
+               .description
+               .version
+               .created_at
+               .updated_at
+               .base_url
+```
+
+
+
+### API request
+
+
+```ruby
+Modgen::API.dataset.get(:id 1)
+```
+
+
+## Test
+
+First start testing API in /test_api and than.
+
+    rake

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new
+
+task default: :spec
+task test:    :spec

data/lib/modgen/api/api_request.rb

@@ -0,0 +1,35 @@
+module Modgen
+  module API
+    class APIRequest < Request
+      
+      attr_reader :api_method
+
+      # Create APIRequest
+      #
+      # == Parameters:
+      # api_method:: Modgen::API::Method
+      # data::
+      #   Hash
+      #     {
+      #       'path'   => {},
+      #       'params' => {},
+      #       'body'   => {}
+      #     }
+      #
+      def initialize(api_method, data)
+        @api_method = api_method
+
+        super(@api_method.url, data, @api_method.http_method.downcase)
+      end
+
+      private
+
+        def _response
+          response = Modgen::Session.get.execute(self)
+          
+          Modgen::API::APIResponse.new(response, self)
+        end
+
+    end
+  end
+end

data/lib/modgen/api/api_response.rb

@@ -0,0 +1,9 @@
+module Modgen
+  module API
+    class APIResponse < Response
+
+      # APIResponse is now the same as Response
+
+    end
+  end
+end

data/lib/modgen/api/request.rb

@@ -0,0 +1,72 @@
+module Modgen
+  module API
+    class Request
+
+      attr_reader :origin_url, :url, :http_method, :data
+
+      # Create Request
+      #
+      # == Data
+      # === path
+      #   data['path'] = {id: 1}
+      #   url = http://a.a/:id
+      #
+      # url will be transfered to
+      #   http://a.a/1
+      #
+      # === params
+      # normal parameters send with request
+      #
+      # === body
+      # this will be posted to the body of request
+      #
+      # == Parameters:
+      # url:: full www adress
+      # data::
+      #   Hash
+      #     {
+      #       'path'   => {},
+      #       'params' => {},
+      #       'body'   => {}
+      #     }
+      # http_method::
+      #   http method
+      #   
+      #   *default:* :get
+      #
+      def initialize(url, data = {}, http_method = :get)
+
+        @origin_url = url
+        @url = url
+        
+        if data['path']
+          @url = url.to_s.gsub(/:([a-z][a-z0-9_]*)/) { data['path'][$1] }
+        end
+
+        @data        = data
+        @http_method = http_method.to_sym
+      end
+      
+      # Send request
+      #
+      def response
+        @response ||= _response
+      end
+
+      private
+
+        def _response
+          conn = Faraday.new(url: @url)
+
+          if @data['body'] && @data['body'].empty?
+            response = conn.send(@http_method, "", @data['params'])
+          else
+            response = conn.send(@http_method, "") { |req| req.body = @data['body'] }
+          end
+
+          Modgen::API::Response.new(response, self)
+        end
+
+    end
+  end
+end

data/lib/modgen/api/response.rb

@@ -0,0 +1,41 @@
+module Modgen
+  module API
+    class Response
+
+      attr_reader :data, :request, :content_type, :body, :status
+
+      def initialize(data, request)
+        @data    = data
+        @request = request
+
+        @status       = data.status
+        @content_type = data.headers['content-type']
+        @body         = _parse_body
+      end
+
+      def error?
+        @status != 200 && @status != 201
+      end
+
+      def error_message
+        if error? && @body
+          @body['error']
+        end
+      end
+
+      def inspect
+        %{#<Modgen::API::Response::0x#{object_id} URL:"#{@request.url}" STATUS_CODE:"#{@status}" BODY:"#{@body}">}
+      end
+
+      private
+
+        def _parse_body
+          case @content_type
+            when 'application/json'
+              return MultiJson.load(@data.body)
+          end
+        end
+      
+    end
+  end
+end

data/lib/modgen/api.rb

@@ -0,0 +1,59 @@
+require 'ostruct'
+
+module Modgen
+  module API
+
+    autoload :Request,  'modgen/api/request'
+    autoload :Response, 'modgen/api/response'
+
+    autoload :APIRequest,  'modgen/api/api_request'
+    autoload :APIResponse, 'modgen/api/api_response'
+
+    autoload :Resource, 'modgen/discovery/resource'
+    autoload :Method,   'modgen/discovery/method'
+
+    @@api = nil
+    @@api_methods = {}
+
+    def self.api
+      @@api || raise(Modgen::APIError, "API has not been discovered yet.")
+    end
+
+    def self.discovered?
+      !@@api.nil?
+    end
+
+    # All available API methods on top
+    #
+    def self.methods
+      @@api_methods.methods
+    end
+
+    # All api methods go there
+    #
+    def self.method_missing(method, *args, &block)
+      api
+
+      @@api_methods.send(method, *args, &block)
+    end
+
+    # Set api from discovery
+    #
+    # == Parameters:
+    # api:: Hash
+    #
+    def self.set_api(api)
+      @@api = OpenStruct.new(api)
+    end
+
+    # Set api methods from discovery
+    #
+    # == Parameters:
+    # api:: Modgen::API::Resource
+    #
+    def self.set_api_methods(api)
+      @@api_methods = api
+    end
+
+  end
+end

data/lib/modgen/configuration.rb

@@ -0,0 +1,47 @@
+module Modgen
+  class Configuration
+
+    DEFAULT = {}
+
+    def initialize(config, use_default = true)
+
+      if use_default
+        config = DEFAULT.merge(config)
+      end
+
+      config.each do |key, value|
+        eval <<-METHOD
+          def #{key}(value = nil, &block)
+            if block_given?
+              @#{key}.instance_eval(&block)
+            end
+
+            if value.nil?
+              if @#{key}.is_a?(Proc)
+                return @#{key}.call
+              end
+              return @#{key}
+            end
+
+            self.#{key} = value
+          end
+
+          def #{key}=(value)
+            @#{key} = value
+          end
+        METHOD
+
+        self.send("#{key}=", value)
+      end
+    end
+
+    def configure(&block)
+      if block_given?
+        yield self
+      end
+
+      self
+    end
+    
+  end
+end

data/lib/modgen/core_ext/hash.rb

@@ -0,0 +1,41 @@
+class Hash
+
+  if !method_defined? :stringify_keys
+    def stringify_keys
+      dup.stringify_keys!
+    end
+  end
+
+  if !method_defined? :stringify_keys!
+    def stringify_keys!
+      keys.each do |key|
+        self[key.to_s] = delete(key)
+      end
+      self
+    end
+  end
+
+  if !method_defined? :symbolize_keys
+    def symbolize_keys
+      dup.symbolize_keys!
+    end
+  end
+
+  if !method_defined? :symbolize_keys!
+    def symbolize_keys!
+      keys.each do |key|
+        self[(key.to_sym rescue key) || key] = delete(key)
+      end
+      self
+    end
+  end
+
+  if !method_defined? :to_param
+    def to_param(namespace = nil)
+      collect do |key, value|
+        value.to_query(namespace ? "#{namespace}[#{key}]" : key)
+      end.sort * '&'
+    end
+  end
+
+end

data/lib/modgen/core_ext/object.rb

@@ -0,0 +1,10 @@
+class Object
+
+  if !method_defined? :to_query
+    def to_query(key)
+      require 'cgi' unless defined?(CGI) && defined?(CGI::escape)
+      "#{CGI.escape(key.to_param)}=#{CGI.escape(to_param.to_s)}"
+    end
+  end
+
+end

data/lib/modgen/core_ext/string.rb

@@ -0,0 +1,9 @@
+class String
+  
+  if !method_defined? :to_param
+    def to_param
+      to_s
+    end
+  end
+
+end

data/lib/modgen/default_configuration.rb

@@ -0,0 +1,29 @@
+require "uri"
+
+module Modgen
+  SITE_URL = 'http://modgen.net'
+
+  OAUTH2_REDIRECT_URI = 'http://localhost/oauth2callback'
+
+  API_CONFIGURATION = {
+    base_url: 'http://modgen.net/api/',
+    discovery_versions_url: -> { URI.join(Modgen.config.api.base_url, 'discovery/versions') },
+    discovery_version_url:  -> { URI.join(Modgen.config.api.base_url, 'discovery/version/:id') },
+  }
+
+  APIKEY_CONFIGURATION = {
+    key: nil
+  }
+
+  OAUTH2_CONFIGURATION = {
+    client_id: nil,
+    client_secret: nil,
+    redirect_uri: nil
+  }
+  
+  DEFAULT_CONFIGURATION = {
+    api:     Modgen::Configuration.new(API_CONFIGURATION),
+    api_key: Modgen::Configuration.new(APIKEY_CONFIGURATION),
+    oauth2:  Modgen::Configuration.new(OAUTH2_CONFIGURATION)
+  }
+end

data/lib/modgen/discovery/discovery.rb

@@ -0,0 +1,71 @@
+module Modgen
+  module Discovery
+
+    def self.config
+      Modgen.config
+    end
+
+    # Download all version and return prefferd version.
+    # If there is not preffered, return nil
+    #
+    def self.preffered_version
+      versions.body['versions'].each do |version, details|
+        if details['preffered']
+          return version
+        end
+      end
+
+      nil
+    end
+
+    # All available version on the server
+    #
+    def self.versions
+      Modgen::API::Request.new(config.api.discovery_versions_url).response
+    end
+
+    # Details of one specific version
+    # If id=nil, client take preffered
+    #
+    def self.version(id = :auto)
+      if id == :auto
+        id = preffered_version
+      end
+
+      params = {'path' => {'id' => id}}
+
+      response = Modgen::API::Request.new(config.api.discovery_version_url, params).response
+
+      if response.error?
+        raise Modgen::APIError, response.error_message
+      end
+
+      response
+    end
+
+    # Discover selected API
+    # If id=nil, client take preffered
+    #
+    def self.discover(id = :auto)
+      
+      data = version(id).body
+
+      api = {
+        name:        data['name'],
+        description: data['description'],
+        version:     data['version'],
+        created_at:  data['created_at'],
+        updated_at:  data['updated_at'],
+        base_url:    data['base_url']
+      }
+      Modgen::API.set_api(api)
+
+      resources = Modgen::API::Resource.new('resources', data['resources'])
+
+      Modgen::API.set_api_methods(resources)
+
+      nil
+    end
+
+  end
+end