fulfil 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 69b547ea14ce54b22cb8b9e33c3da0fc60872fca
+  data.tar.gz: 2a335cfebd8a62ce25112ae99ee5edfc6cf70cb4
+SHA512:
+  metadata.gz: 23b30ab2b82afa7c8a8f1344b5f4d65aa0d2a0798684e5632997dfddcc6822a9a1fb2a6e08fcb8867abe8d69bbe59da460d066d88d41caab179f6c593d93eb49
+  data.tar.gz: f9604a77e96c2e5a83dbc76107dbef7f13ba2d710a8e52f048ad9248eed5d671f7bd09ccbdeaf762523bdc709ffa90e29254c8af2ae796feb7f64a2472533960

data/lib/fulfil/base.rb

@@ -0,0 +1,44 @@
+# This is the base class for all models. Each object in response is an object of this class.
+
+require 'fulfil'
+require 'json'
+module Fulfil
+  class Base
+
+    def initialize(args)
+      @args = args
+    end
+
+    class << self
+    # Method to get single object using ID
+      def get(id)
+        raise ArgumentError, 'Please provide an ID' if id.to_s.empty?
+        request.get id
+      end
+
+      # Method to get all objects in a model
+      def all(page=1,per_page=10)
+        request.all({:page => page, :per_page => per_page})
+      end
+
+      # Method to find specific object in a model using filters
+      def find(filter=[],page=1,per_page=10)
+        raise ArgumentError, 'Please provide a filter' if filter.empty?
+        request.find({:filter => filter, :page => page, :per_page => per_page})
+      end
+
+      # TODO
+      #def create(data)
+        #request.create(data)
+      #eend
+
+    end
+
+    # This will return arguments as object methods.
+    def method_missing(method)
+      method = method.to_s
+      raise NoMethodError, "No such method: #{method}" unless @args.keys.include? method
+      @args[method]
+    end
+  end
+end

data/lib/fulfil/constants.rb

@@ -0,0 +1,5 @@
+# All constants go here.
+module Fulfil
+  BASE_URL = "https://%{subdomain}.fulfil.io/api/v1/model/".freeze
+  PRODUCT_PATH = "product.product".freeze
+end

data/lib/fulfil/errors/base_error.rb

@@ -0,0 +1,7 @@
+# All errors goes here.
+module Fulfil
+  class UnauthorizedError < StandardError ; end
+  class AuthenticationError < StandardError ; end
+  class UserError < StandardError ; end
+  class HostResolutionError < StandardError ; end
+end

data/lib/fulfil/product.rb

@@ -0,0 +1,16 @@
+# Product Model
+require 'fulfil'
+require 'fulfil/constants'
+require 'fulfil/request'
+require 'fulfil/base'
+
+module Fulfil
+  class Product < Base
+    class << self
+      private
+      def request
+        Fulfil::Request.new(Fulfil::PRODUCT_PATH)
+      end
+    end
+  end
+end

data/lib/fulfil/request.rb

@@ -0,0 +1,83 @@
+# Used to issue requests to API. All models call this class to issue requests.
+require 'fulfil'
+require 'fulfil/constants'
+require 'fulfil/errors/base_error'
+require 'curb'
+
+module Fulfil
+  class Request
+    def initialize(url)
+      check_auth_params
+      @options ={
+        base_url:  (Fulfil::BASE_URL % {subdomain: Fulfil.authentication[:subdomain]}) << url,
+        api_key:  Fulfil.authentication[:api_key]
+      }
+    end
+
+    def get(id)
+      request :get, {}, "/#{id}"
+    end
+
+    def all(data)
+      request :get, data
+    end
+
+    def find(data)
+      request :get, data
+    end
+
+    # TODO
+    #def create(data)
+     # request :post, data
+    #end
+
+    private
+
+    # USed to check if auth is done properly before making calls
+    def check_auth_params
+      if (Fulfil.authentication.nil? || Fulfil.authentication[:subdomain].empty? || Fulfil.authentication[:api_key].empty?)
+        raise Fulfil::AuthenticationError, "Please set your subdomain and api key"
+      end
+    end
+
+    # Issue request and get response
+    def request(http_method, data={}, url="")
+      final_url = @options[:base_url] << url
+        begin
+          case http_method
+              when :get
+                response = Curl.get(final_url, data) do |http|
+                  http.headers['x-api-key'] = @options[:api_key]
+                  http.headers['Accept'] = 'application/json'
+                end
+          end
+        rescue Curl::Err::HostResolutionError
+          raise Fulfil::HostResolutionError, "Invalid Subdomain"
+        end
+      parse_response response
+    end
+
+    def parse_response response
+        if response.response_code == 401
+          raise Fulfil::UnauthorizedError, "Unauthorized access"
+        else
+          create_response response
+        end
+    end
+
+    # Recursively builds response as object of Fulfil::Base class.
+    def create_response response
+      json = JSON.parse(response.body_str)
+      if json.is_a?(Array)
+        result = json.map {|result| Fulfil::Base.new(result)}
+      else
+        result = Fulfil::Base.new(json)
+        if result.type == "UserError"
+          raise Fulfil::UserError, result.message
+        end
+      end
+      result
+    end
+
+  end
+end

data/lib/fulfil/version.rb

@@ -0,0 +1,3 @@
+module Fulfil
+  VERSION = "0.0.1"
+end

data/lib/fulfil.rb

@@ -0,0 +1,12 @@
+# Basic authentication
+require "fulfil/version"
+require "fulfil/product"
+
+module Fulfil
+  class << self
+    attr_accessor :authentication, :base_url
+    def setup(subdomain,api_key)
+      self.authentication = { subdomain: subdomain, api_key: api_key }
+    end
+  end
+end

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: fulfil
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Manoj M J
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-07-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 10.4.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 10.4.2
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: curb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.3
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+description: ''
+email:
+- manojmj92@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/fulfil.rb
+- lib/fulfil/base.rb
+- lib/fulfil/constants.rb
+- lib/fulfil/errors/base_error.rb
+- lib/fulfil/product.rb
+- lib/fulfil/request.rb
+- lib/fulfil/version.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: fulfil.io REST API Gem
+test_files: []