easy_api_operations 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d37e8fee6cfdb0688816b209303c051756486ea2
+  data.tar.gz: fa06caab4a7f4ccf9937881abfec62d16298cce5
+SHA512:
+  metadata.gz: b55dd4119e00616a38e448995e11741a48122a3f4bd175a1a0db4950a1cdfef52f8e8aadf982cd6b465f62ac19b365dcb7bc91374de404039e637d4ecd031066
+  data.tar.gz: abbf2f789630801603718ddeb81ab9f6dad4344b6b91d758b64eab8d53721779585f11b350da41cac768139262fac9a08a550b284afa9e1f28a967f7ef129abe

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.1

data/Gemfile

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

data/README.md

@@ -0,0 +1,39 @@
+# EasyApiOperations
+
+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/easy_api_operations`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'easy_api_operations'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install easy_api_operations
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/easy_api_operations/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "easy_api_operations"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/easy_api_operations.gemspec

@@ -0,0 +1,22 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'easy_api_operations/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "easy_api_operations"
+  spec.version       = EasyApiOperations::VERSION
+  spec.authors       = ["Bjoern Moeller / Christian Hentke"]
+  spec.summary       = "build api operations via one liner"
+  spec.description   = "call .set_up_api(self, ressource_name, operations) within grape api and you will be able to get the api build for you."
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "easy_model_selects"
+end

data/lib/easy_api_operations/version.rb

@@ -0,0 +1,3 @@
+module EasyApiOperations
+  VERSION = "0.1.1"
+end

data/lib/easy_api_operations.rb

@@ -0,0 +1,188 @@
+require "easy_api_operations/version"
+
+module EasyApiOperations
+      def self.set_up_api(api, ressource_name, operations)
+        operations.downcase
+        ressource_name.capitalize
+      
+        #ressources are singular and plural
+        #methods are primary_key, get, put, delete and post
+        #option all is the easiest
+      
+        api_version = api.parent_name
+
+        http_codes_hash = {
+            200 => 'Ok',
+            400 => 'Invalid parameter entry',
+            403 => 'Not allowed',
+            404 => 'No appointment found'
+          }
+        http_codes_hash_extra_creates = {500 => 'unable to create/update'}
+      
+      
+        #for understanding:
+          #(api_version + "::Entities::" + ressource_name.pluralize).constantize ==  API::V1::Entities::Appointments
+          #(api_version + "::Entities::" + ressource_name + "UpdateBody").constantize ==  API::V1::Entities::AppointmentUpdateBody
+          #(api_version + "::Entities::" + ressource_name + "CreateBody").constantize ==  API::V1::Entities::AppointmentCreateBody
+          #ressource_name.constantize == Appointment
+    
+    
+  #___________ressource plural start
+          if operations.include?("plural") or operations.include?("all")
+            api.resource ressource_name.downcase.pluralize.to_sym do
+
+    #___________get_______________start__________________   
+              #!!!description + params that can be requested -> currently the same as the once you get back, this can be adjusted (see other possibilities at the end)
+              if operations.include?("plural_get") or operations.include?("all")
+                desc "Returns a list of #{ressource_name}. Limited by 1000", params: (api_version + "::Entities::" + ressource_name.pluralize).constantize.documentation#, entity: API::V1::Entities::Appointments
+                get do
+                  if params.empty?
+                    present "Choose something dude"
+                  else
+                    results = ressource_name.constantize.where(EasyModelSelects.get_where_statement_from_param(params)).order(ressource_name.constantize.primary_key).limit(1000)
+                    present results, with: (api_version + "::Entities::" + ressource_name.pluralize).constantize
+                  end
+                end
+              else
+                #no plural_get
+              end 
+            end
+          else
+            #no plural
+          end
+      
+  #___________ressource singulare start
+          if operations.include?("singular") or operations.include?("all")
+            api.resource ressource_name.downcase.to_sym do
+
+    #___________get_primary_key_______________start__________________ 
+              if operations.include?("singular_primary_key") or operations.include?("all")
+                desc "Returns the primary key from #{ressource_name.pluralize}"
+                #!!! get then the path addition
+                get "primary_key" do
+                  ressource_name.constantize.primary_key.to_sym
+                end
+              else
+              #no singular_primary_key
+              end
+
+    #___________get_______________start__________________       
+              if operations.include?("singular_get") or operations.include?("all")   
+                desc "Returns #{ressource_name.indefinitize} by #{ressource_name.constantize.primary_key}"
+                params do
+                  requires ressource_name.constantize.primary_key, type: Integer, desc: "#{ressource_name} #{ressource_name.constantize.primary_key}"
+                end
+                get "#{ressource_name.constantize.primary_key.to_sym}", http_codes: http_codes_hash do
+                  instance_variable = ressource_name.constantize.where("#{ressource_name.constantize.primary_key} IN (?)", params[ressource_name.constantize.primary_key]).first
+                  if instance_variable.nil?
+                    error! http_codes_hash[404], 404
+                  end
+                  present instance_variable, with: (api_version + "::Entities::" + ressource_name).constantize
+                end
+              else
+                #no singular_get
+              end
+    #___________put_______________start__________________
+              if operations.include?("singular_put") or operations.include?("all")
+                desc "Updates #{ressource_name.indefinitize} by #{ressource_name.constantize.primary_key}"
+                params do
+                  #!!!no need to require the primary_key as it is requested within the body already, change the body, change this part
+                  #requires Appointment.primary_key, type: String,  desc: "Appointment #{Appointment.primary_key}"
+                  optional :body, type: (api_version + "::Entities::" + ressource_name + "UpdateBody").constantize,  desc: 'Body to update params'
+                end
+                put ressource_name.constantize.primary_key, http_codes: http_codes_hash.merge(http_codes_hash_extra_creates) do
+
+                  instance_variable = ressource_name.constantize.where("#{ressource_name.constantize.primary_key} IN (?)", params[ressource_name.constantize.primary_key]).first
+                  if instance_variable.nil?
+                    error! http_codes_hash[404], 404
+                  end
+          
+                  transformed_params = (api_version + "::Entities::" + ressource_name + "UpdateBody").constantize.represent(params, serializable: true)
+                  transformed_params.keys.each do |key|
+                    if transformed_params[key].nil?
+                      transformed_params.delete(key)
+                    end
+                  end
+        
+                  if instance_variable.update!(transformed_params)
+                    status 204
+                  else
+                    error! http_codes_hash_extra_creates[500], 500
+                  end
+                end
+              else
+                #no singular_put
+              end
+
+    #___________delete_______________start__________________
+              if operations.include?("singular_delete") or operations.include?("all")
+                desc "Deletes #{ressource_name.indefinitize} by #{ressource_name.constantize.primary_key}"
+        
+                params do
+                  requires ressource_name.constantize.primary_key, type: String,  desc: "#{ressource_name} #{ressource_name.constantize.primary_key}"
+                end
+                delete ressource_name.constantize.primary_key, http_codes: http_codes_hash do
+                  instance_variable = ressource_name.constantize.where("#{ressource_name.constantize.primary_key} IN (?)", params[ressource_name.constantize.primary_key]).first
+          
+                  if instance_variable.nil?
+                    error! http_codes_hash[404], 404
+                  else
+                    instance_variable.destroy
+                    status 204
+                  end
+          
+                end
+              else
+                #no singular pluaral
+              end
+        
+    #___________create_______________start__________________
+              if operations.include?("singular_post") or operations.include?("all")
+                desc "Creates #{ressource_name.indefinitize}"#, entity: API::V1::Entities::Appointments
+                params do
+                  optional :body, type: (api_version + "::Entities::" + ressource_name + "CreateBody").constantize,  desc: "Body to create #{"Appointment".indefinitize}"
+                end
+                post http_codes: http_codes_hash.merge(http_codes_hash_extra_creates) do
+
+
+                  transformed_params = (api_version + "::Entities::" + ressource_name + "CreateBody").constantize.represent(params, serializable: true)
+
+                  transformed_params.keys.each do |key|
+                    if transformed_params[key].nil?
+                      transformed_params.delete(key)
+                    end
+                  end
+      
+                  instance_variable = ressource_name.constantize.create(transformed_params)
+                  if instance_variable.save
+                    #status 204
+                    body instance_variable.send("#{ressource_name.constantize.primary_key}")
+                  else
+                    error! http_codes_hash_extra_creates[500], 500
+                  end
+                end
+              else
+                #no singular_post
+              end
+            end
+          else
+            #no singular ressource
+          end
+  
+          #!!!other possibilities for more flexible param / respond structure
+  
+              # paginate :per_page => 100
+   
+              #!!!just show the attributes that are allowed by the modul
+                #prohibited_attributes = Appointment.get_prohibited_attributes
+              #!!! create params out of this
+      #         params do
+      #           optional :modified_since, documentation: { type: :string, desc: "Appointments created or modified since a certain date. Format: '2015-04-03T15:53:33.428Z'"}
+      #           Appointment.get_prohibited_attributes_with_types.each do |column, type|
+      #             optional column, documentation: { type: type, desc: "Optional Appointment property: #{column}"} # unless type.methods.include? :delimiter
+      #            # optional column, type: :array, desc: "Optional Appointment property: #{column}" if type.methods.include? :delimiter
+      #           end
+      #         end
+      end
+  
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: easy_api_operations
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Bjoern Moeller / Christian Hentke
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-09-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: easy_model_selects
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: call .set_up_api(self, ressource_name, operations) within grape api and
+  you will be able to get the api build for you.
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- easy_api_operations.gemspec
+- lib/easy_api_operations.rb
+- lib/easy_api_operations/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.4.6
+signing_key: 
+specification_version: 4
+summary: build api operations via one liner
+test_files: []