mockolate 0.0.0 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: af8d46e40e4912a888bd6e2fc702d57855588736f628e1b72fe8496423dadc11
-  data.tar.gz: 7677af9ed20ef12cbd2d16b3589bbb3ee38557882ce1b3b6581d406d54497f18
+  metadata.gz: 5995709b20221b067022d29e769c8b71e06165f2e947d02dc58f9f5208497d33
+  data.tar.gz: 69678030088be972616b562c39e050bcaa7c61b7ec024fb99d0769438d6f3304
 SHA512:
-  metadata.gz: 02ee6e2d51b825eaac270d50b51aa21e01529227fe0dbf700fc19f072d80711775faaa09a17692e8f9bd047ce699755a081f719383d7c34108790b081531726a
-  data.tar.gz: 50b2edfa9071d1778bad47e69794d588cec66aa343e58aeb1fa40cf2a391f322a779b25d23182dba15bbec81b9fd169fb9fc0502e39706f32a9fa844b7666f7f
+  metadata.gz: 269f132b9bc65e7d7e2faa21d4cf63d2b2a8b56ca4e0aa18d00555e2559b3da53595782e576ddd58575f2ac8427f65bcdf0734f68ecb6e1eddb72ea99873eded
+  data.tar.gz: bc3a0d18e15e8d1a673e4c2411442764e8c180257535eae671d5435a9e98f4e18afcc46ed8b136a9f26c1b66bf99bc55bc93774d7edcb9f1c6cfae2491486858

data/Gemfile.lock

@@ -2,11 +2,17 @@ PATH
   remote: .
   specs:
     mockolate (0.0.0)
+      faker
 
 GEM
   remote: https://rubygems.org/
   specs:
+    concurrent-ruby (1.1.5)
     diff-lcs (1.3)
+    faker (2.10.0)
+      i18n (>= 1.6, < 1.8)
+    i18n (1.7.0)
+      concurrent-ruby (~> 1.0)
     rake (10.5.0)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)

data/README.md

@@ -1,8 +1,12 @@
+
 # mockolate
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/mockolate`. To experiment with that code, run `bin/console` for an interactive prompt.
+  
+
+ ## Description
 
-TODO: Delete this and the text above, and describe your gem
+Mockolate is easy to us endpoint (service) faker with mock responses. It can also be  used as DSL for hash
+  
 
 ## Installation
 
@@ -14,15 +18,62 @@ gem 'mockolate'
 
 And then execute:
 
-    $ bundle
+```
+$ bundle
+```
 
 Or install it yourself as:
-
-    $ gem install mockolate
+  
+```
+$ gem install mockolate
+```
 
 ## Usage
+  
+Create hash object using Request class and its dsl
+
+```ruby
+class UserRequestParams < Mockolate::Request
+  payload do
+    string    :firstname,    fake_from: 'Name', key: 'first_name'
+    string    :lastname,     fake_from: 'Name', key: 'last_name'
+    integer   :age,          value: 21
+    array     :books do 
+      hash do
+        string    :name,      value: 'Tehlikeli Oyunlar'
+        string    :author,    value: 'Oguz Atay'
+        integer   :published, value: 1973
+      end
+      hash do
+        string    :name,      value: '1984'
+        string    :author,    value: 'George Orwell'
+        integer   :published, value: 1949
+      end
+    end
+  end
+end
+
+```
+
+You can even generate dynamic data by using `fake_from` and `key` options which using Faker gem under the hood
+If you planning to access the hash with key pass `export_with` option to payload
+For results use `generate_array!` or `generate_hash!` (which returns nested hash with export key) instance methods.
 
-TODO: Write usage instructions here
+`UserRequestParams.new.generate_array!`
+
+Consume data from remote endpoint created data by `Mockolate::Request`
+
+```ruby
+class UserService < Mockolate::Response
+  object_from UserRequestParams
+  
+  define_endpoint! :profile_by_email do |email|
+    object[email]
+  end
+end
+
+UserService.new.profile_by_email('johndoe@example.com')
+```
 
 ## Development
 
@@ -32,8 +83,8 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/mockolate.
+Bug reports and pull requests are welcome on GitHub at https://github.com/0x2C6/mockolate.  
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/mockolate.rb

@@ -1,11 +1,14 @@
 # frozen_string_literal: true
 
-require "mockolate/version"
-require "mockolate/parameters"
-require "mockolate/parameters/generator"
+require 'faker'
+require 'mockolate/version'
+require 'mockolate/errors'
+require 'mockolate/types'
+require 'mockolate/register'
+require 'mockolate/request'
+require 'mockolate/response'
+require 'mockolate/request/parser'
+require 'mockolate/initializers'
 
 module Mockolate
-  # extend ActiveSupport::Autoload
-  
-  # autoload :Parameters
 end

data/lib/mockolate/errors.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Mockolate::Errors
+  class MockolateError        < StandardError;  end
+
+  class FakerKeyNotFound      < MockolateError; end
+  class TypeNotFound          < MockolateError; end
+  class MissingHashBlockError < MockolateError; end
+  class MissingValueError     < MockolateError; end
+end

data/lib/mockolate/initializers.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Mockolate::Initializers
+  Mockolate::Register.set   :string,    Mockolate::Types::String
+  Mockolate::Register.set   :integer,   Mockolate::Types::Integer
+  Mockolate::Register.set   :hash,      Mockolate::Types::Hash
+  Mockolate::Register.set   :array,     Mockolate::Types::Array
+end

data/lib/mockolate/register.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Mockolate::Register
+  @@types = {}
+
+  def self.set(type, type_module)
+    @@types[type] = type_module
+  end
+
+  def self.get(type)
+    @@types[type]
+  end
+end

data/lib/mockolate/request.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+class Mockolate::Request
+  @@public_attributes = []
+  @@payloads = []
+  @@payload_options   = {}
+
+  def self.payload(options = {}, &block)
+    @@payloads << payload_parser(options, &block)
+  end
+
+  def self.payload_parser(options = {}, &block)
+    @@payload_options = options
+    dsl = DSL.new(@@payload_options)
+    dsl.instance_exec(&block)
+    @@public_attributes = dsl.attributes
+  end
+
+  def self.params
+    @@public_attributes
+  end
+
+  def generate_array!(count = nil)
+    attr_arr = @@payloads
+    parser = Parser.new(attr_arr)
+    parser.parse
+  end
+
+  def generate_hash!(count = nil)
+    attr_arr = @@payloads
+    parser = Parser.new(attr_arr, @@payload_options)
+    parser.parse
+  end
+
+  class DSL
+    attr_accessor :attributes
+    attr_reader   :options
+    
+    def initialize(options)
+      @attributes = []
+      @options    = options  
+    end
+
+    def hash(*args, &block)
+      raise Mockolate::Errors::MissingHashBlockError unless block_given?
+      method_missing(:hash, *args, &block)
+    end
+
+    def method_missing(type, *args, &block)
+      metadata   = Mockolate::Register.get(type)
+      field_name = args.first
+      type_options    = args[1]
+      
+      attibute = metadata.create(name: field_name, options: type_options)
+      if block_given?
+        attibute.children = Mockolate::Request.payload_parser(options, &block)
+      end
+      attributes << attibute
+    end
+  end
+
+end

data/lib/mockolate/request/parser.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+class Mockolate::Request::Parser
+  attr_reader :_attr_arr
+  attr_reader :_export_key
+  
+  def initialize(attr_arr, options = {})
+    @_attr_arr = attr_arr
+    @_export_key  = options[:export_with]
+  end
+
+  def parse
+    return _parse_to_hash if _export_key
+    _parse_to_array
+  end
+
+  private
+  def _parse_to_hash
+    export_hash = {}
+    _attr_arr.each do |attr|
+      hash = {}
+      attr.each do |t|
+        hash.merge! t.parse
+      end  
+      export_hash[hash[_export_key]] = hash
+    end
+    return export_hash
+  end
+
+  def _parse_to_array
+    _attr_arr.map do |attr|
+      _hash = Hash.new
+      
+      attr.each do |t|
+        _hash.merge! t.parse
+      end  
+      _hash
+    end
+  end
+
+end

data/lib/mockolate/response.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+class Mockolate::Response
+  @@object_class = nil
+
+  def self.define_endpoint!(mtd, &block)
+    method(:define_method).call(mtd, &block)
+  end
+
+  def object
+    @@object_class.generate_hash!
+  end
+
+  def self.object_from(request_class)
+    raise Exception unless request_class.new.is_a? Mockolate::Request
+    @@object_class = request_class.new 
+  end
+end

data/lib/mockolate/types.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+class Mockolate::Types
+  def self.inherited(base)
+    base.extend TypeFactory
+    base.extend TypeMetaData
+  end
+  
+  module TypeFactory
+    def create(name:, options: {})
+      new(
+        name:    name,
+        options: options
+      )
+    end
+  end
+
+  module TypeMetaData
+    def self.extended(base)
+      base.class_eval do
+        attr_reader   :name,  :options
+        attr_accessor :children
+
+        def initialize(name:, options: nil)
+          @name     = name
+          @options  = options
+          @children = []
+        end
+
+        def parse
+          return name => value
+        end
+
+        def has_children?
+          !children.empty?
+        end
+
+        def value
+          _get_value.public_send(_cast)
+        end
+
+        private
+        def _get_value
+          options[:value] || _get_from_faker!
+        end
+
+        def _parse_child
+          children.flatten.map do |child|
+            child.parse
+          end
+        end
+
+        def _cast
+          class_name = self.class.name.split('::')
+
+          return "to_#{class_name.last[0].downcase}".to_sym
+        end
+
+        def _get_from_faker!
+          Object.const_get(
+            "Faker::#{options[:fake_from]}"
+          ).public_send(options[:key])
+        end
+        
+      end
+    end
+  end
+
+  require 'mockolate/types/string'
+  require 'mockolate/types/integer'
+  require 'mockolate/types/hash'
+  require 'mockolate/types/array'
+end

data/lib/mockolate/types/array.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+class Mockolate::Types::Array < Mockolate::Types
+  # Public Methods
+  # name:            Name of the key specified in params block
+  # has_children:    Returns children elements of hash
+  #
+  # Private Methods
+  # _parse_child    Returns array with parsed children
+
+  def parse
+    return name => [].push(*_parse_child)
+  end
+end

data/lib/mockolate/types/hash.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+class Mockolate::Types::Hash < Mockolate::Types
+  # Public Methods
+  # name:            Name of the key specified in params block
+  # has_children:    Returns children elements of hash
+  #
+  # Private Methods
+  # _parse_child    Returns array with parsed children
+  
+  def parse
+    return name => {}.merge(*_parse_child) if name
+    {}.merge(*_parse_child)
+  end
+end

data/lib/mockolate/types/integer.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+class Mockolate::Types::Integer < Mockolate::Types
+  # Public Methods
+  # name:     Name of the key specified in params block
+  # options:  Options of the key specified in params block
+  # value:    Returns default value if specified, or fetchs data from faker
+
+  # def parse
+  #   super
+  # end
+end

data/lib/mockolate/types/string.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+class Mockolate::Types::String < Mockolate::Types
+  # Public Methods
+  # name:     Name of the key specified in params block
+  # options:  Options of the key specified in params block
+  # value:    Returns default value if specified, or fetchs data from faker
+
+  # def parse
+  #   super
+  # end
+end

data/lib/mockolate/validators.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Mockolate::Validators
+  class << self
+    def check_value_given?(obj)
+      return if _check_has_default_value?(obj) || _check_both_given?(obj)
+      raise Mockolate::Errors::MissingValueError, 'Default value or all Faker options should be given'
+    end
+
+    def check_faker(obj)
+
+    end
+
+    private
+    def _check_has_default_value?(obj)
+      !!obj[:value]
+    end
+
+    def _check_has_faker_key?(obj)
+      return !!obj[:key] 
+    end
+
+    def _check_has_faker_module?(obj)
+      return !!obj[:fake_from]
+    end
+
+    def _check_both_given?(obj)
+      _check_has_faker_key?(obj) &&  _check_has_faker_module?(obj)
+    end
+  end
+end

data/lib/mockolate/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Mockolate
-  VERSION = "0.0.0"
+  VERSION = "0.1.0"
 end

data/mockolate.gemspec

@@ -26,4 +26,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 2.0"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
+
+  spec.add_dependency             "faker"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mockolate
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.1.0
 platform: ruby
 authors:
 - Farhad
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-12-27 00:00:00.000000000 Z
+date: 2020-01-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: faker
+  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: Multi purpose mock, dummy objects, dummy responses generator library
 email:
 - farhad9801@gmail.com
@@ -70,13 +84,18 @@ files:
 - bin/console
 - bin/setup
 - lib/mockolate.rb
-- lib/mockolate/parameters.rb
-- lib/mockolate/parameters/attributes.rb
-- lib/mockolate/parameters/attributes/macros.rb
-- lib/mockolate/parameters/attributes/parser.rb
-- lib/mockolate/parameters/attributes/types.rb
-- lib/mockolate/parameters/generator.rb
-- lib/mockolate/parameters/hooks.rb
+- lib/mockolate/errors.rb
+- lib/mockolate/initializers.rb
+- lib/mockolate/register.rb
+- lib/mockolate/request.rb
+- lib/mockolate/request/parser.rb
+- lib/mockolate/response.rb
+- lib/mockolate/types.rb
+- lib/mockolate/types/array.rb
+- lib/mockolate/types/hash.rb
+- lib/mockolate/types/integer.rb
+- lib/mockolate/types/string.rb
+- lib/mockolate/validators.rb
 - lib/mockolate/version.rb
 - mockolate.gemspec
 homepage: 
@@ -98,7 +117,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Like chocolate, but, way sweeter

data/lib/mockolate/parameters.rb

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-
-require "mockolate/parameters/generator"
-require "mockolate/parameters/attributes"
-require "mockolate/parameters/hooks"
-
-class Mockolate::Parameters
-  # include Mockolate::Parameters::Generator
-  # include Mockolate::Parameters::Attributes
-  include Mockolate::Parameters::Hooks
-  
-  def self.inherited(base)
-    initialize!(base)
-  end
-end

data/lib/mockolate/parameters/attributes.rb

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-
-require "mockolate/parameters/attributes/macros"
-
-class Mockolate::Parameters
-  module Attributes
-    include Mockolate::Parameters::Attributes::Macros
-    # def self.included(base)
-    #   # base.include Mockolate::Parameters::Attributes::Macros
-    # end
-
-    # module ClassMethods      
-    # end
-  end  
-end

data/lib/mockolate/parameters/attributes/macros.rb

@@ -1,35 +0,0 @@
-# frozen_string_literal: true
-
-require "mockolate/parameters/attributes/parser"
-
-module Mockolate::Parameters::Attributes
-  # This module includes main macros definitions
-  module Macros
-    def self.included(base)
-      base.extend ClassMethods
-    end
-
-    module ClassMethods
-      include Mockolate::Parameters::Attributes::Parser
-      
-      # Handles single attribute which may have constant values
-      # @param attr [String] key of attribute
-      # @yield block
-      def attribute(attr, &block)
-        parse!(attr, &block)
-        # class_variable_get(:@@_public_attributes).merge
-      end
-
-      # Handles multiple attributes
-      # @param attrs [Array<String>] key of attribute
-      def attributes(*attrs)
-        parse!(attrs)
-        # attr.each do |attr|
-        #   return parse_hash(attr) if attr.is_a? Hash
-        #   parse_symbol
-        # end
-        # class_variable_get(:@@_public_attributes).push *attrs
-      end
-    end
-  end  
-end

data/lib/mockolate/parameters/attributes/parser.rb

@@ -1,30 +0,0 @@
-# frozen_string_literal: true
-
-require "mockolate/parameters/attributes/types"
-
-module Mockolate::Parameters::Attributes
-  module Parser
-    include Mockolate::Parameters::Attributes::Types
-    
-    def parse!(obj, &block)
-      return _parse_attribute_from_symbol(obj, &block) if obj.kind_of? Symbol
-      return _parse_attributes_from_array(obj) if obj.kind_of? Array
-    end
-
-    private
-    def _parse_attributes_from_array(attrs) 
-      attrs.map do |attr|
-        _parse_attribute_from_symbol(attr)
-      end
-    end
-
-    def _parse_attribute_from_symbol(sym, type = :string, &block)
-      return yield if block_given? 
-
-      class_variable_get(:@@_public_attributes).merge!({sym => method(type).call(sym)})
-    end
-
-    def _parse_attribute_from_hash(obj)
-    end
-  end  
-end

data/lib/mockolate/parameters/attributes/types.rb

@@ -1,21 +0,0 @@
-# frozen_string_literal: true
-
-module Mockolate::Parameters::Attributes
-  module Types
-    def string(name)
-      # class_variable_get(:@@_public_attributes).merge!(
-        {value: '', type: :string}
-      # )
-    end
-
-    def integer(name)
-      class_variable_get(:@@_public_attributes).merge!(
-        name.to_sym => {value: 0, type: :integer}
-      )
-    end
-  
-    # def type_hander(&block)
-
-    # end
-  end  
-end

data/lib/mockolate/parameters/generator.rb

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-
-class Mockolate::Parameters
-  module Generator
-    def self.included(base)
-      base.extend ClassMethods
-    end
-
-    module ClassMethods
-      # def generate
-      #   {is_dummy: 'Yes'}
-      # end
-    end
-  end  
-end

data/lib/mockolate/parameters/hooks.rb

@@ -1,28 +0,0 @@
-# frozen_string_literal: true
-
-# frozen_string_literal: true
-
-class Mockolate::Parameters
-  module Hooks
-    def self.included(base)
-      base.extend ClassInitializers
-    end
-    
-    module ClassInitializers
-      # Function runs after a class inherited from Mockolate::Parameters
-      # @params [Class] class to override
-      def initialize!(base)
-        base.class_eval do
-          # Included modules
-          include Mockolate::Parameters::Attributes::Macros
-          # include Mockolate::Parameters::Generator
-          # include Mockolate::Parameters::Attributes
-
-          # class variables and attributes
-          class_variable_set :@@_public_attributes, {}
-        end
-      end
-    end
-  
-  end  
-end