simplify_api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 60a0e19049ebda23b3ab1eba59e4eca72579f590da586d6196bfdf6e496f5d79
+  data.tar.gz: efc09f9794de5e0857eeda5724cfb12e0e9e7fc9269d4c705c9c107ae4ab2a4a
+SHA512:
+  metadata.gz: 9b6e714f718dee139a49b4af1f605079e1863aeb2d6e7cca656ca5d7eef5c546788fb7bd820424ce0a5723b77dbb9fba7d43ead11537c684f8a86ccbf8e15948
+  data.tar.gz: 77a6264dd517f32ed8ec9243b6207695e1d7cb0fb7cb4f3d3ca5ee5f92edddc983798ef6f4a53a385696050ebbdb44b00b02dea905de34243cb23f7af4b3f16d

data/.gitignore

@@ -0,0 +1,6 @@
+/.bundle/
+/Gemfile.lock
+/spec/reports/
+/tmp/
+/vendor/
+*.gem

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in bot_engine.gemspec
+gemspec

data/README.md

@@ -0,0 +1,65 @@
+# SimplifyApi
+
+Simplify the use of APIs in Ruby.
+
+The simplicity is really that you can define your API as Ruby classes, and throwing in a JSON string you'll have all your objects created.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'simplify_api'
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+
+```ruby
+require 'simplify_api'
+
+class Options
+  include SimplifyApi
+  attribute :key, String, mandatory: true
+  attribute :value, String, mandatory: true
+end
+
+class ServiceDescription
+  include SimplifyApi
+  attribute :service_id, Integer, mandatory: true
+  attribute :services, [String]
+end
+
+class ApiCallParameters
+  include SimplifyApi
+  attribute :id, Integer, mandatory: true
+  attribute :name, String
+  attribute :gender, String, values: ["Male", "Female", "Other"]
+  attribute :email, String
+  attribute :options, [Options]
+  attribute :service_description, ServiceDescription
+end
+
+api_parameters = ApiCallParameters.new id: 1, name: "MyApi", options: [{key: "Create", value: "/api/create"}, {key: "Update", value: "/api/update"}], service_description: {service_id: 1, services: ["Create", "Update"]}
+# => #<ApiCallParameters:0x0000000002b09ff8 @id=1, @name="MyApi", @options=[#<Options:0x0000000002b09670 @key="Create", @value="/api/create">, #<Options:0x0000000002b08608 @key="Update", @value="/api/update">], @service_description=#<ServiceDescription:0x0000000002b07aa0 @service_id=1, @services=["Create", "Update"]>>
+
+api_parameters.to_h
+# => {:id=>1, :name=>"MyApi", :options=>[{:key=>"Create", :value=>"/api/create"}, {:key=>"Update", :value=>"/api/update"}], :service_description=>{:service_id=>1, :services=>["Create", "Update"]}}
+```
+
+This setup is ideal to toss in Hashed versions of JSON data and instantiate your objects.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/rodgco/simplify_api. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](https://www.contributor-covenant.org/) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+Ruby is Beautiful!!!

data/lib/simplify_api.rb

@@ -0,0 +1,3 @@
+require 'json'
+
+require 'simplify_api/simplify_api'

data/lib/simplify_api/simplify_api.rb

@@ -0,0 +1,100 @@
+module SimplifyApi
+  def self.included(base)
+    base.singleton_class.send(:attr_accessor, :attributes)
+    base.attributes = {}
+    base.singleton_class.send(:attr_accessor, :mandatory)
+    base.mandatory = []
+    base.singleton_class.send(:attr_accessor, :default)
+    base.default = {}
+    base.extend(ClassMethods)
+  end
+
+  module ClassMethods
+    def attribute(attr, type = Object, **args)
+      raise ArgumentError, "Duplicate attribute #{attr}." if self.attributes[attr]
+      if type.class == Array then
+        args[:default] = [] unless args[:default]
+        args[:array_type] = type[0]
+      end
+      self.attributes[attr] = {
+        name: attr.to_s,
+        type: type.class == Class ? type : type.class == Array ? Array : Object,
+        params: args
+      }
+      self.mandatory << attr if args[:mandatory]
+      self.default["#{attr}".to_sym] = args[:default] if args[:default]
+      self.attributes[attr]
+    end
+  end
+
+  def initialize(opts)
+    opts.each_pair do |k, v|
+      case v
+      when Hash
+        v = self.class.attributes[k][:type].new(v)
+      when Array
+        v.collect! { |i| self.class.attributes[k][:params][:array_type].new(i) }
+      end
+      create_and_set_instance_variable("#{k}", v)
+    end
+    raise ArgumentError, "Missing mandatory attributes => #{self.class.mandatory-self.instance_variables}" if not mandatory_attributes_in?
+    self.class.default.each_pair do |k, v|
+      create_and_set_instance_variable(k, v) unless self.instance_variables.include?("@#{k}".to_sym)
+    end
+    self
+  end
+
+  def to_h
+    h = {}
+    instance_variables.each do |i|
+      k = /\@(.*)/.match(i.to_s)[1].to_sym
+      v = instance_variable_get(i)
+      if v.class == Array then
+        h[k] = []
+        v.each {|a| h[k] << (a.respond_to?(:to_h) ? a.to_h : a) }
+      else
+        h[k] = v.respond_to?(:to_h) ? v.to_h : v
+      end
+    end
+    return h
+  end
+
+  def to_json
+    self.to_h.to_json
+  end
+  
+  def method_missing(method_name, *args, &block)
+    case method_name
+    when /(.*)\=$/
+      create_and_set_instance_variable("#{$1}", args[0])
+    else
+      super(method_name, args, block)
+    end
+  end
+
+  def respond_to_missing?(method_name, *args)
+    case method_name
+    when /(.*)\=$/
+      true # always respond to assignment methods
+    else
+      super(method_name, args)
+    end
+  end
+
+  private
+  def create_and_set_instance_variable(name, value)
+    define_singleton_method("#{name}=") do |arg| 
+      valid_values = self.class.attributes[name.to_sym][:params][:values]
+      raise "Argument Error. Invalid value for #{name} => #{arg}" if valid_values && !valid_values.include?(arg)
+      instance_variable_set("@#{name}", arg)
+    end
+    define_singleton_method("#{name}") do
+      instance_variable_get("@#{name}")
+    end
+    self.send("#{name}=", value)
+  end
+
+  def mandatory_attributes_in?
+    self.class.mandatory.collect {|v| self.instance_variables.include?("@#{v}".to_sym)}.inject(&:&)
+  end
+end

data/lib/simplify_api/version.rb

@@ -0,0 +1,3 @@
+module SimplifyApi
+  VERSION = "0.1.0"
+end

data/simplify_api.gemspec

@@ -0,0 +1,20 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'simplify_api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "simplify_api"
+  spec.version       = SimplifyApi::VERSION
+  spec.date          = "2019-05-07"
+  spec.authors       = ["Rodrigo Garcia Couto"]
+  spec.email         = ["r@rodg.co"]
+  spec.summary       = %q{A simple set of tools to help the use of APIs}
+  spec.description   = %q{Fairly usable. A simple set of tools to simplify the use of APIs in Ruby}
+  spec.homepage      = "https://github.com/rodgco/simplify_api"
+  spec.license       = "MIT"
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification
+name: simplify_api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Rodrigo Garcia Couto
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-05-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: Fairly usable. A simple set of tools to simplify the use of APIs in Ruby
+email:
+- r@rodg.co
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- README.md
+- lib/simplify_api.rb
+- lib/simplify_api/simplify_api.rb
+- lib/simplify_api/version.rb
+- simplify_api.gemspec
+homepage: https://github.com/rodgco/simplify_api
+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.7.3
+signing_key: 
+specification_version: 4
+summary: A simple set of tools to help the use of APIs
+test_files: []