diff --git a/.gitignore b/.gitignore index 76fc4ea..68fe640 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,4 @@ _site .sass-cache .DS_Store +.bundle diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ab4360c..add540e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,15 +1,15 @@ Contributing ============ -The http://www.ruby-grape.org site is work of [many contributors](https://github.com/ruby-grape/ruby-grape.github.io/graphs/contributors). You're encouraged to submit [pull requests](https://github.com/ruby-grape/ruby-grape.github.io/pulls) and [propose topics](https://github.com/ruby-grape/ruby-grape.github.io/issues). When in doubt, ask a question in the [Grape Google Group](http://groups.google.com/group/ruby-grape). +The https://www.ruby-grape.org site is work of [many contributors](https://github.com/ruby-grape/ruby-grape.github.io/graphs/contributors). You're encouraged to submit [pull requests](https://github.com/ruby-grape/ruby-grape.github.io/pulls) and [propose topics](https://github.com/ruby-grape/ruby-grape.github.io/issues). When in doubt, ask a question in the [Grape Google Group](http://groups.google.com/group/ruby-grape). #### Fork the Project Fork the [project on Github](https://github.com/ruby-grape/ruby-grape.github.io) and check out your copy. ``` -git clone https://github.com/contributor/grape.git -cd grape +git clone https://github.com/contributor/ruby-grape.github.io.git +cd ruby-grape.github.io git remote add upstream https://github.com/ruby-grape/ruby-grape.github.io.git ``` diff --git a/Gemfile.lock b/Gemfile.lock index 8e040cb..c33d66e 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -1,126 +1,224 @@ GEM remote: http://rubygems.org/ specs: - RedCloth (4.2.9) - activesupport (4.2.0) + activesupport (4.2.8) i18n (~> 0.7) - json (~> 1.7, >= 1.7.7) minitest (~> 5.1) thread_safe (~> 0.3, >= 0.3.4) tzinfo (~> 1.1) - blankslate (2.1.2.4) - celluloid (0.16.0) - timers (~> 4.0.0) - classifier-reborn (2.0.3) - fast-stemmer (~> 1.0) - coffee-script (2.3.0) + addressable (2.8.0) + public_suffix (>= 2.0.2, < 5.0) + coffee-script (2.4.1) coffee-script-source execjs - coffee-script-source (1.8.0) - colorator (0.1) - execjs (2.2.2) - fast-stemmer (1.0.2) - ffi (1.9.6) - gemoji (2.1.0) - github-pages (31) - RedCloth (= 4.2.9) - github-pages-health-check (~> 0.2) - jekyll (= 2.4.0) + coffee-script-source (1.12.2) + colorator (1.1.0) + ethon (0.14.0) + ffi (>= 1.15.0) + execjs (2.7.0) + faraday (1.8.0) + faraday-em_http (~> 1.0) + faraday-em_synchrony (~> 1.0) + faraday-excon (~> 1.1) + faraday-httpclient (~> 1.0.1) + faraday-net_http (~> 1.0) + faraday-net_http_persistent (~> 1.1) + faraday-patron (~> 1.0) + faraday-rack (~> 1.0) + multipart-post (>= 1.2, < 3) + ruby2_keywords (>= 0.0.4) + faraday-em_http (1.0.0) + faraday-em_synchrony (1.0.0) + faraday-excon (1.1.0) + faraday-httpclient (1.0.1) + faraday-net_http (1.0.1) + faraday-net_http_persistent (1.2.0) + faraday-patron (1.0.0) + faraday-rack (1.0.0) + ffi (1.15.4) + forwardable-extended (2.6.0) + gemoji (3.0.0) + github-pages (139) + activesupport (= 4.2.8) + github-pages-health-check (= 1.3.3) + jekyll (= 3.4.3) + jekyll-avatar (= 0.4.2) jekyll-coffeescript (= 1.0.1) - jekyll-mentions (= 0.2.1) - jekyll-redirect-from (= 0.6.2) - jekyll-sass-converter (= 1.2.0) - jekyll-sitemap (= 0.6.3) - jemoji (= 0.4.0) - kramdown (= 1.3.1) - liquid (= 2.6.1) - maruku (= 0.7.0) + jekyll-default-layout (= 0.1.4) + jekyll-feed (= 0.9.2) + jekyll-gist (= 1.4.0) + jekyll-github-metadata (= 2.3.1) + jekyll-mentions (= 1.2.0) + jekyll-optional-front-matter (= 0.1.2) + jekyll-paginate (= 1.1.0) + jekyll-readme-index (= 0.1.0) + jekyll-redirect-from (= 0.12.1) + jekyll-relative-links (= 0.4.0) + jekyll-sass-converter (= 1.5.0) + jekyll-seo-tag (= 2.2.3) + jekyll-sitemap (= 1.0.0) + jekyll-swiss (= 0.4.0) + jekyll-theme-architect (= 0.0.4) + jekyll-theme-cayman (= 0.0.4) + jekyll-theme-dinky (= 0.0.4) + jekyll-theme-hacker (= 0.0.4) + jekyll-theme-leap-day (= 0.0.4) + jekyll-theme-merlot (= 0.0.4) + jekyll-theme-midnight (= 0.0.4) + jekyll-theme-minimal (= 0.0.4) + jekyll-theme-modernist (= 0.0.4) + jekyll-theme-primer (= 0.2.1) + jekyll-theme-slate (= 0.0.4) + jekyll-theme-tactile (= 0.0.4) + jekyll-theme-time-machine (= 0.0.4) + jekyll-titles-from-headings (= 0.1.5) + jemoji (= 0.8.0) + kramdown (= 1.13.2) + liquid (= 3.0.6) + listen (= 3.0.6) mercenary (~> 0.3) - pygments.rb (= 0.6.0) - rdiscount (= 2.1.7) - redcarpet (= 3.1.2) + minima (= 2.1.1) + rouge (= 1.11.1) terminal-table (~> 1.4) - github-pages-health-check (0.2.1) - net-dns (~> 0.6) - public_suffix (~> 1.4) - hitimes (1.2.2) - html-pipeline (1.9.0) + github-pages-health-check (1.3.3) + addressable (~> 2.3) + net-dns (~> 0.8) + octokit (~> 4.0) + public_suffix (~> 2.0) + typhoeus (~> 0.7) + html-pipeline (2.6.0) activesupport (>= 2) - nokogiri (~> 1.4) - i18n (0.7.0) - jekyll (2.4.0) - classifier-reborn (~> 2.0) - colorator (~> 0.1) - jekyll-coffeescript (~> 1.0) - jekyll-gist (~> 1.0) - jekyll-paginate (~> 1.0) + nokogiri (>= 1.4) + i18n (0.8.4) + jekyll (3.4.3) + addressable (~> 2.4) + colorator (~> 1.0) jekyll-sass-converter (~> 1.0) jekyll-watch (~> 1.1) kramdown (~> 1.3) - liquid (~> 2.6.1) + liquid (~> 3.0) mercenary (~> 0.3.3) - pygments.rb (~> 0.6.0) - redcarpet (~> 3.1) + pathutil (~> 0.9) + rouge (~> 1.7) safe_yaml (~> 1.0) - toml (~> 0.1.0) + jekyll-avatar (0.4.2) + jekyll (~> 3.0) jekyll-coffeescript (1.0.1) coffee-script (~> 2.2) - jekyll-gist (1.1.0) - jekyll-mentions (0.2.1) - html-pipeline (~> 1.9.0) - jekyll (~> 2.0) + jekyll-default-layout (0.1.4) + jekyll (~> 3.0) + jekyll-feed (0.9.2) + jekyll (~> 3.3) + jekyll-gist (1.4.0) + octokit (~> 4.2) + jekyll-github-metadata (2.3.1) + jekyll (~> 3.1) + octokit (~> 4.0, != 4.4.0) + jekyll-mentions (1.2.0) + activesupport (~> 4.0) + html-pipeline (~> 2.3) + jekyll (~> 3.0) + jekyll-optional-front-matter (0.1.2) + jekyll (~> 3.0) jekyll-paginate (1.1.0) - jekyll-redirect-from (0.6.2) - jekyll (~> 2.0) - jekyll-sass-converter (1.2.0) - sass (~> 3.2) - jekyll-sitemap (0.6.3) - jekyll-watch (1.2.0) - listen (~> 2.7) - jemoji (0.4.0) - gemoji (~> 2.0) - html-pipeline (~> 1.9) - jekyll (~> 2.0) - json (1.8.1) - kramdown (1.3.1) - liquid (2.6.1) - listen (2.8.4) - celluloid (>= 0.15.2) + jekyll-readme-index (0.1.0) + jekyll (~> 3.0) + jekyll-redirect-from (0.12.1) + jekyll (~> 3.3) + jekyll-relative-links (0.4.0) + jekyll (~> 3.3) + jekyll-sass-converter (1.5.0) + sass (~> 3.4) + jekyll-seo-tag (2.2.3) + jekyll (~> 3.3) + jekyll-sitemap (1.0.0) + jekyll (~> 3.3) + jekyll-swiss (0.4.0) + jekyll-theme-architect (0.0.4) + jekyll (~> 3.3) + jekyll-theme-cayman (0.0.4) + jekyll (~> 3.3) + jekyll-theme-dinky (0.0.4) + jekyll (~> 3.3) + jekyll-theme-hacker (0.0.4) + jekyll (~> 3.3) + jekyll-theme-leap-day (0.0.4) + jekyll (~> 3.3) + jekyll-theme-merlot (0.0.4) + jekyll (~> 3.3) + jekyll-theme-midnight (0.0.4) + jekyll (~> 3.3) + jekyll-theme-minimal (0.0.4) + jekyll (~> 3.3) + jekyll-theme-modernist (0.0.4) + jekyll (~> 3.3) + jekyll-theme-primer (0.2.1) + jekyll (~> 3.3) + jekyll-theme-slate (0.0.4) + jekyll (~> 3.3) + jekyll-theme-tactile (0.0.4) + jekyll (~> 3.3) + jekyll-theme-time-machine (0.0.4) + jekyll (~> 3.3) + jekyll-titles-from-headings (0.1.5) + jekyll (~> 3.3) + jekyll-watch (1.5.1) + listen (~> 3.0) + jemoji (0.8.0) + activesupport (~> 4.0) + gemoji (~> 3.0) + html-pipeline (~> 2.2) + jekyll (>= 3.0) + kramdown (1.13.2) + liquid (3.0.6) + listen (3.0.6) rb-fsevent (>= 0.9.3) - rb-inotify (>= 0.9) - maruku (0.7.0) - mercenary (0.3.5) - mini_portile (0.6.2) - minitest (5.5.0) - net-dns (0.8.0) - nokogiri (1.6.5) - mini_portile (~> 0.6.0) - parslet (1.5.0) - blankslate (~> 2.0) - posix-spawn (0.3.9) - public_suffix (1.4.6) - pygments.rb (0.6.0) - posix-spawn (~> 0.3.6) - yajl-ruby (~> 1.1.0) - rb-fsevent (0.9.4) - rb-inotify (0.9.5) - ffi (>= 0.5.0) - rdiscount (2.1.7) - redcarpet (3.1.2) - safe_yaml (1.0.4) - sass (3.4.9) - terminal-table (1.4.5) - thread_safe (0.3.4) - timers (4.0.1) - hitimes - toml (0.1.2) - parslet (~> 1.5.0) - tzinfo (1.2.2) + rb-inotify (>= 0.9.7) + mercenary (0.3.6) + mini_portile2 (2.8.6) + minima (2.1.1) + jekyll (~> 3.3) + minitest (5.10.2) + multipart-post (2.1.1) + net-dns (0.9.0) + nokogiri (1.16.5) + mini_portile2 (~> 2.8.2) + racc (~> 1.4) + octokit (4.21.0) + faraday (>= 0.9) + sawyer (~> 0.8.0, >= 0.5.3) + pathutil (0.16.2) + forwardable-extended (~> 2.6) + public_suffix (2.0.5) + racc (1.7.3) + rb-fsevent (0.11.0) + rb-inotify (0.10.1) + ffi (~> 1.0) + rouge (1.11.1) + ruby2_keywords (0.0.5) + safe_yaml (1.0.5) + sass (3.7.4) + sass-listen (~> 4.0.0) + sass-listen (4.0.0) + rb-fsevent (~> 0.9, >= 0.9.4) + rb-inotify (~> 0.9, >= 0.9.7) + sawyer (0.8.2) + addressable (>= 2.3.5) + faraday (> 0.8, < 2.0) + terminal-table (1.8.0) + unicode-display_width (~> 1.1, >= 1.1.1) + thread_safe (0.3.6) + typhoeus (0.8.0) + ethon (>= 0.8.0) + tzinfo (1.2.10) thread_safe (~> 0.1) - yajl-ruby (1.1.0) + unicode-display_width (1.2.1) PLATFORMS ruby DEPENDENCIES github-pages + +BUNDLED WITH + 1.15.1 diff --git a/README.md b/README.md index 4806a34..b2fd2a6 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ ![](images/grape.png) -Grape is an opinionated micro-framework for creating REST-like APIs in Ruby. -This is the Jekyll source for the site at http://www.ruby-grape.org. +Grape is an opinionated framework for creating REST-like APIs in Ruby. +This is the Jekyll source for the site at https://www.ruby-grape.org. Please contribute to this site, see [CONTRIBUTING](CONTRIBUTING.md). diff --git a/_config.yml b/_config.yml index f4921a9..ecff98f 100644 --- a/_config.yml +++ b/_config.yml @@ -1,10 +1,7 @@ title: - long: Ruby Grape | An opinionated micro-framework for creating REST-like APIs in Ruby. + long: Ruby Grape | An opinionated framework for creating REST-like APIs in Ruby. short: Ruby Grape locale: en_US -url: # http://www.ruby-grape.org -markdown: kramdown -highlighter: pygments sass: sass_dir: _sass style: compressed @@ -15,7 +12,7 @@ kramdown: owner: name: Ruby Grape avatar: logo.png - info: An opinionated micro-framework for creating REST-like APIs in Ruby. + info: An opinionated framework for creating REST-like APIs in Ruby. email: ruby-grape@googlegroups.com disqus-shortname: twitter: grapeframework diff --git a/_includes/_footer.html b/_includes/_footer.html index f1f7786..86bfdee 100644 --- a/_includes/_footer.html +++ b/_includes/_footer.html @@ -1 +1,5 @@ -© 2010-{{ site.time | date: '%Y' }} {{ site.owner.name }}. Powered by Jekyll based on the Minimal Mistakes theme. + + © 2010-{{ site.time | date: '%Y' }} {{ site.owner.name }}. | + Powered by Jekyll based on the Minimal Mistakes theme. | + Suggest an Edit + diff --git a/code_of_conduct/index.md b/code_of_conduct/index.md new file mode 100644 index 0000000..8173798 --- /dev/null +++ b/code_of_conduct/index.md @@ -0,0 +1,28 @@ +--- +layout: page +title: Code of Conduct +tags: [code of conduct] +comments: false +--- +### Code of Conduct + +As contributors and maintainers of Ruby Grape and community projects, and in the interest of fostering an open and welcoming community, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities. + +We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, religion, or nationality. + +Examples of unacceptable behavior by participants include: + +* The use of sexualized language or imagery +* Personal attacks +* Trolling or insulting/derogatory comments +* Public or private harassment +* Publishing other's private information, such as physical or electronic addresses, without explicit permission +* Other unethical or unprofessional conduct. + +Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. By adopting this Code of Conduct, project maintainers commit themselves to fairly and consistently applying these principles to every aspect of managing this project. Project maintainers who do not follow or enforce the Code of Conduct may be permanently removed from the project team. + +This code of conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. + +Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers. + +This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.2.0, available at [http://contributor-covenant.org/version/1/2/0/](http://contributor-covenant.org/version/1/2/0/) diff --git a/examples/index.md b/examples/index.md index ce9a284..a5205f0 100644 --- a/examples/index.md +++ b/examples/index.md @@ -13,23 +13,22 @@ comments: false * [Grape on Goliath on Heroku with Postgres](https://github.com/djones/grape-goliath-example): An example app using Goliath and Grape running on Heroku with Postgres, using a non-blocking flavor of ActiveRecord and the non-blocking Postgres database adapter. * [Goliath + Grape + MongoDB, on Heroku](https://github.com/lgs/GGM): Experimenting with Goliath asyncronous ruby web server framework, Grape APIs, gitwatcher.com data on MongoLAB/MongoDB and Heroku PAAS. * [ConfAsk Source](https://github.com/mbleigh/conf_ask): Source for the example Grape application demonstrated in the Grapes of Rapid talk at RubyConf 2010. -* [Example Rails implementation](http://martinciu.com/2011/01/mounting-grape-api-inside-rails-application.html): A blog post explaining how to go about building a basic API for a Rails app using 3.x or 2.3x. -* [Another Example of Basic Rails implementation](http://www.ruby-on-rails-outsourcing.com/2011/07/22/build-a-basic-api-in-a-rails-3-application): A short but detailed blog post showing how to set up a simple Grape API in Rails 3 * [A Sample Blogging API](https://github.com/bloudraak/grape-sample-blog-api): An API for an over-simplified blogging system that directly interacts with the database models. * [A Grape w/ Warden Sample](https://github.com/dblock/grape_warden): A Grape API mounted on Rack with very simple authentication using Warden. * [Grape on Rack w/ ActiveRecord](https://github.com/cutalion/grape-api-example): Grape API mounted on Rack, using ActiveRecord, Roar Representers, Swagger and FDoc. * [Grape API v1 inside API v2](https://github.com/dblock/grape-on-rack-v1-inside-v2): Evolve a Grape API v1 into API v2, explain in [this blog post](http://code.dblock.org/evolving-apis-using-grape-api-versioning). * [Grape with ROAR](https://github.com/ruby-grape/grape-with-roar): A demo of using Grape with Roar and some non-trivial HAL presenters. -* [Grape with ROAR](https://github.com/CansaSCitySchuffle/grape-roar-example): Example of Grape using Roar with header versioning, API inheritance and Swagger. -* [Grape with Paperclip](https://github.com/omarfouad/rails_api_with_ajax_upload): Example of a Grape API mounted on Rails, to upload files with Paperclip & pure AJAX. Details in [this blog post](http://omarfouad.com/blog/2013/08/18/file-upload-api-with-grape-and-rails). +* [Grape with ROAR](https://github.com/alwinmark/grape-roar-example): Example of Grape using Roar with header versioning, API inheritance and Swagger. +* [Grape with Paperclip](http://omarfouad.com/blog/2013/08/18/file-upload-api-with-grape-and-rails): Example of a Grape API mounted on Rails, to upload files with Paperclip & pure AJAX. * [Grape ToDo API](https://github.com/mateuszkosmider/todo-grape-api): A ToDo application. * [Grape w/ Rack-OAuth2](https://github.com/balauru/grape-oauth2-sample): Rack app running a Grape API and secured via OAuth2 via rack-oauth2. +* [Grape Doorkeeper](https://github.com/sethherr/grape-doorkeeper): Rails, Doorkeeper (OAuth2 provider), Grape & Swagger. * [Accept-Version Header example](https://github.com/williamn/notes): Grape app mounted on Rails with `:accept_version_header` versioning strategy. * [Rails-Grape-Entity](https://github.com/philcallister/rails-grape-entity): a TODO app with grape and grape-entity. * [Grape w/ Rack + MongoDB](https://github.com/thiagogsr/grape-bootstrap): a bootstrap app to help you to start a Grape application without Rails -* [Gitlab](https://github.com/gitlabhq/gitlabhq): Real world example of working grape API. -* [zup-api](https://github.com/LaFabbrica/zup-api): Large nicely structured grape app. -* [evercam-api](https://github.com/evercam/evercam-api): Grape application that manages all communication between Evecam Media & Evercam Clients. +* [GitLab](https://gitlab.com/gitlab-org/gitlab-foss): Real world example of working grape API. +* [Grape API Bootstrap Application](https://github.com/Oliveirakun/grape-bootstrap): Basic API application with ActiveRecord, RSpec, Swagger UI and Docker. +* [Grape API boilerplate](https://github.com/duffn/grape-api-boilerplate): A full fledged, production ready, and easy to understand API boilerplate. ### Contribute diff --git a/index.md b/index.md index 7711314..29fe896 100644 --- a/index.md +++ b/index.md @@ -4,23 +4,20 @@ comments: false --- [Community Projects](/projects) -Grape ecosystem projects. +
Grape ecosystem projects. [Resources](/resources) -Useful resources. +
Useful resources. [Examples](/examples) -Working projects using Grape. +
Working projects using Grape. [Users](/users) -Who uses Grape? +
Who uses Grape? -[History and Team](/team) -Who maintains Grape? - -[Want to help?](https://github.com/ruby-grape/ruby-grape.github.io/issues) -A number of non-code, community-related work-items you can help with. +[History, Team and Contributing](/team) +
Who maintains Grape? How can I contribute? [Need help?](https://groups.google.com/forum/#!forum/ruby-grape) -Please join and use the ruby-grape Google group for all questions. +
Please join and use the ruby-grape Google group for all questions. diff --git a/projects/index.md b/projects/index.md index 75f9c8d..6a3ffa8 100644 --- a/projects/index.md +++ b/projects/index.md @@ -7,16 +7,16 @@ comments: false ### Core -* [grape](https://github.com/ruby-grape/grape): An opinionated micro-framework for creating REST-like APIs in Ruby. +* [grape](https://github.com/ruby-grape/grape): An opinionated framework for creating REST-like APIs in Ruby. * [ruby-grape.github.io](https://github.com/ruby-grape/ruby-grape.github.io): The ruby-grape community site. ### Entities and Representers * [grape-entity](https://github.com/ruby-grape/grape-entity): An API focused facade that sits on top of an object model. -* [grape-rabl](https://github.com/LTe/grape-rabl): Use Rabl templates. -* [grape-active_model_serializers](https://github.com/jrhe/grape-active_model_serializers): User active_model_serializers. +* [grape-rabl](https://github.com/ruby-grape/grape-rabl): Use Rabl templates. +* [grape-roar](https://github.com/ruby-grape/grape-roar): Use Roar with Grape. +* [grape-active_model_serializers](https://github.com/ruby-grape/grape-active_model_serializers): Use active_model_serializers. * [grape-msgpack](https://github.com/rosylilly/grape-msgpack): Message pack formatter. -* [grape-resources](https://github.com/wawandco/grape-resources) Extension that allows to scaffold easily models that could not contain much logic. ### Caching @@ -25,10 +25,11 @@ comments: false * [grape-rails-cache](https://github.com/monterail/grape-rails-cache): HTTP and server side cache integration with Rails. * [grape-shaman_cache](https://github.com/wjp2013/grape-shaman_cache): HTTP and server side cache integration for a non-Rails application and Jbuilder. * [grape-cache](https://github.com/AlexYankee/grape-cache): Another Grape middleware-style caching gem. +* [grape-present_cache](https://github.com/u2/grape-present_cache): Grape fragment cache. ### Data -* [grape-activerecord](https://github.com/jhollinger/grape-activerecord): A simple way to use ActiveRecord with your Grape apps. +* [otr-activerecord](https://github.com/jhollinger/otr-activerecord): A simple way to use ActiveRecord with your Grape apps. * [api-pagination](https://github.com/davidcelis/api-pagination): Pagination with [will_paginate](https://github.com/mislav/will_paginate) or [kaminari](https://github.com/amatsuda/kaminari). * [grape-kaminari](https://github.com/monterail/grape-kaminari): [Kaminari](https://github.com/amatsuda/kaminari) paginator integration. @@ -38,35 +39,43 @@ comments: false * [grape-throttle](https://github.com/xevix/grape-throttle): Provides a simple endpoint-specific throttling mechanism. * [grape-batch](https://github.com/c4mprod/grape-batch): Rack middleware which extends Grape::API to support request batching. +### Idempotency + +* [grape-idempotency](https://github.com/jcagarcia/grape-idempotency): Gem for supporting idempotency in your Grape APIs. + ### Routing * [grape-route-helpers](https://github.com/reprah/grape-route-helpers): Path helpers for Grape APIs, similar to Rails' named path helpers. +* [grape-raketasks](https://github.com/reprah/grape-raketasks): Rake task to print out Grape API routes, similar to Rails' rake routes. ### Logging * [grape_logging](https://github.com/aserafin/grape_logging): Provides simple request logging capabilities (response code, path, parameters, request time, etc). -* [grape-papertrail](https://github.com/sardaukar/grape-papertrail): [PaperTrail](https://github.com/airblade/paper_trail) integration for Grape. -* [grape-present_cache](https://github.com/u2/grape-present_cache): Grape fragment cache. +* [grape-middleware-logger](https://github.com/ridiculous/grape-middleware-logger): Middleware that logs the request path, endpoint name, parameters, response status, errors and duration. ### Authentication and Authorization * [grape-doorkeeper](https://github.com/fuCtor/grape-doorkeeper): Grape integration with Doorkeeper. * [grape_api_signature](https://github.com/faber-lotto/grape_api_signature): A RACK-Based AWS Style signature authentication for grape API. * [wine_bouncer](https://github.com/antek-drzewiecki/wine_bouncer): Doorkeeper OAuth2 authorization middleware for grape APIs. +* [grape_token_auth](https://github.com/mcordell/grape_token_auth): Grape token auth gem for frontend JavaScript apps ([ng-token-auth](https://github.com/lynndylanhurley/ng-token-auth) compatible). +* [grape_oauth2](https://github.com/nbulaj/grape_oauth2): Flexible, fully customizable and simple OAuth2 provider for Grape API. ### Documentation -* [grape-swagger](https://github.com/tim-vandecasteele/grape-swagger): Provides an autogenerated documentation for your Grape API. +* [grape-swagger](https://github.com/ruby-grape/grape-swagger): Provides an autogenerated documentation for your Grape API. +* [grape-swagger-rails](https://github.com/ruby-grape/grape-swagger-rails): Swagger UI as Rails Engine for grape-swagger gem. * [grape-swagger-ui](https://github.com/kendrikat/grape-swagger-ui): Integrates swagger-ui with the Rails asset pipeline. -* [grape-swagger-rails](https://github.com/TinkerDev/grape-swagger-rails): Swagger UI as Rails Engine for grape-swagger gem. -* [grape-slate](https://github.com/connexio-labs/grape-slate): Allows for generating a Slate style for your API. +* [grape-apiary](https://github.com/connexio-labs/grape-apiary): Generate an Apiary Blueprint for you Grape API. +* [grape-swagger-entity](https://github.com/ruby-grape/grape-swagger-entity): Provides grape-entity models parsing for swagger autogenerated documentation. +* [grape-swagger-representable](https://github.com/ruby-grape/grape-swagger-representable): Provides representable models parsing for swagger autogenerated documentation. ### Monitoring, Performance & Instrumentation -* [newrelic-grape](https://github.com/xinminlabs/newrelic-grape): NewRelic instrumentation. * [grape-librato](https://github.com/seanmoon/grape-librato): Librato metrics. * [grape-appsignal](https://github.com/aai/grape-appsignal): Integration with AppSignal. * [grape-oink](https://github.com/xevix/grape-oink): Identify routes which significantly increase VM heap size using [oink parser](https://github.com/noahd1/oink). +* [skylight](https://github.com/skylightio/skylight-ruby): Integration with Skylight, [documentation](https://docs.skylight.io/grape). ### Development @@ -81,6 +90,8 @@ comments: false * [grape-scaffold](https://github.com/icicletech/grape-scaffold): An API scaffold generator for Rails. * [grape-api-generator](https://github.com/vinh0604/grape-api-generator): Some rails generators to help quickly bootstrap new Grape API structure. * [gris](https://github.com/artsy/gris): A framework (and generators) for building [hal+json hypermedia](http://stateless.co/hal_specification.html) API services using Rack, Grape, Roar, RSpec, and ActiveRecord. +* [grape-starter](https://github.com/LeFnord/grape-starter) Quickly create a API skeleton using Rack, Grape, Grape Swagger and Sequel or ActiveRecord. +* [grapethor](https://rawongithub.github.io/grapethor) Grape REST-like API application generator based on Thor. ### Opinionated Frameworks diff --git a/resources/index.md b/resources/index.md index db97cd0..2790038 100644 --- a/resources/index.md +++ b/resources/index.md @@ -7,9 +7,9 @@ comments: false * [Google Group](https://groups.google.com/group/ruby-grape): Get Grape help here. * [Anatomy of a Ruby Gem: Grape](https://vimeo.com/98830727): A screencast digging through the internals of Grape. -* [The Grapes of Rapid](http://confreaks.net/videos/475-rubyconf2010-the-grapes-of-rapid): RubyConf 2010 presentation about Grape and [slides](https://github.com/downloads/ruby-grape/grape/The%20Grapes%20of%20Rapid.pdf). +* [The Grapes of Rapid](https://www.youtube.com/watch?v=C7beg3OzxC4): RubyConf 2010 presentation about Grape and [slides](https://github.com/downloads/ruby-grape/grape/The%20Grapes%20of%20Rapid.pdf). * [API Authentication w/ Devise](http://code.dblock.org/grape-api-authentication-w-devise): A tutorial on how to use Grape with Devise/Warden authentication. * [RESTful APIs with Grape](http://www.slideshare.net/dblockdotorg/building-restful-apis-w-grape): NYC.rb presentation about Grape in 2011. -* [From Zero to API Cache in 10 Minutes](http://www.confreaks.com/videos/986-goruco2012-from-zero-to-api-cache-w-grape-mongodb-in-10-minutes): a 10-minute talk at GoRuCo 2012 about API caching with Grape. +* [From Zero to API Cache in 10 Minutes](https://www.youtube.com/watch?v=e9HLflRXMcA): a 10-minute talk at GoRuCo 2012 about API caching with Grape. * [OAuth2: Protect Grape API with Doorkeeper](http://blog.yorkxin.org/posts/2013/11/05/oauth2-tutorial-grape-api-doorkeeper-en): a tutorial for protecting a Grape API with OAuth 2 protocol using Doorkeeper and Ruby on Rails with a [working sample](https://github.com/chitsaou/oauth2-api-sample). -* [Combine Swagger with Grape to Create an Interactive Documentation of Your API](http://bitboxer.de/2014/02/09/grape). +* [API Heaven with Grape and Swagger](http://bitboxer.de/2014/02/09/rails-api/). diff --git a/team/index.md b/team/index.md index 22dd7e4..531f65f 100644 --- a/team/index.md +++ b/team/index.md @@ -8,20 +8,53 @@ comments: false Grape was created by [Michael Bleigh](https://github.com/mbleigh) at [Intridea](http://www.intridea.com/) and [made its debut at RubyConf 2010 in New Orleans](http://confreaks.tv/videos/rubyconf2010-the-grapes-of-rapid). [Jerry Cheung](https://github.com/jch) had later joined development. Grape left the Intridea home on August 3rd, 2015 and became an independent project that belongs to the Ruby community. Today Grape is maintained by [Daniel Doubrovkine](https://github.com/dblock) and consists of [numerous projects](/projects), each individually maintained by a growing group that is defined by rough concensus and running code. Grape is used by many thousands of developers and numerous commercial and non-commercial applications. [Grape itself](https://github.com/ruby-grape/grape) had 6,462 stars and 726 forks on Github as of August 3rd, 2015. -### Core Team +### Organization Maintainers * [Daniel Doubrovkine, @dblock](https://github.com/dblock), CTO at [Artsy.net](https://www.artsy.net), New York, USA. * [Michael Bleigh, @mbleigh](https://github.com/mbleigh): CEO at [DivShot](https://www.divshot.com), Los Angeles, USA. -* [Dmitry Dedov, @dm1try](https://github.com/dm1try): Minsk, Belarus. -* [Adam Gotterer, @adamgotterer](https://github.com/adamgotterer): New York, USA. ### Individual Project Maintainers +#### [grape](https://github.com/ruby-grape/grape) + +* [Dmitry Dedov, @dm1try](https://github.com/dm1try): Minsk, Belarus. +* [Adam Gotterer, @adamgotterer](https://github.com/adamgotterer): New York, USA. +* [Vladimir Kochnev, @marshall-lee](https://github.com/marshall-lee): Saint Petersburg, Russia. +* [Kunpei Sakai, @namusyaka](https://github.com/namusyaka): Tokyo, Japan. + #### [grape-entity](https://github.com/ruby-grape/grape-entity) * [Vladimir Kochnev, @marshall-lee](https://github.com/marshall-lee): Saint Petersburg, Russia. * [Mark Madsen, @idyll](https://github.com/idyll): The Great White North. +#### [grape-swagger](https://github.com/ruby-grape/grape-swagger) + +* [Tim Vandecasteele, @tim-vandecasteele](https://github.com/tim-vandecasteele): Gent, Belgium. +* [Craig S. Cottingham, @CraigCottingham](https://github.com/CraigCottingham): Olathe, Kansas, USA. +* [Peter Scholz, @le_fnord](https://github.com/LeFnord): Leipzig, Germany. +* [Kirill Zaitsev, @Bugagazavr](https://github.com/Bugagazavr): Moscow, Russia. + +#### [grape-swagger-rails](https://github.com/ruby-grape/grape-swagger-rails) + +* [Alexander Logunov, @unloved](https://github.com/unloved): Cheboksary, Russia. +* [Andrew Schuster, @aschuster3](https://github.com/aschuster3): Atlanta, Georgia, USA. + +#### [grape-rabl](https://github.com/ruby-grape/grape-rabl) + +* [Piotr Niełacny, @LTe](https://github.com/LTe): Wrocław, Poland. + +#### [grape-active_model_serializers](https://github.com/ruby-grape/grape-active_model_serializers) + +* [Jonathan Evans, @jrhe](https://github.com/jrhe): London, UK. +* [Teng Siong Ong, @siong1987](https://github.com/siong1987): San Francisco, USA. +* [Darren Cheng, @drn](https://github.com/drn): San Francisco, USA. + ### Participating in the Grape Community We welcome all contributors to the Grape ecosystem, built upon rough consensus and running code, a principle described in the [Tao of IETF](https://www.ietf.org/tao.html). We are highly inclusive, try to be nice and helpful to both experienced and new developers. We encourage you to participate and to be pragmatic. To quote David Clark, _"We reject kings, presidents and voting"_, and Jon Postel, _"Be conservative in what you send and liberal in what you accept."_ + +We also have a [contributor code of conduct](/code_of_conduct). + +### Becoming a Project Maintainer + +Team members from organizational maintainers down to individual project nominate individuals who have significantly contributed to the project to join the team. We recommend requiring a simple majority and no significant objections (also known as rough consensus) as a sufficient criteria for acceptance. A great first step in becoming a maintainer of any project could be making a release. diff --git a/users/index.md b/users/index.md index c50c666..d975600 100644 --- a/users/index.md +++ b/users/index.md @@ -7,8 +7,16 @@ comments: false ### Companies +There're thousands of companies using Grape, this page was started recently. The more people use Grape and talk about it, the better Grape becomes! Please do [contribute the name of your company](https://github.com/ruby-grape/ruby-grape.github.io/blob/master/CONTRIBUTING.md) to [this page](https://github.com/ruby-grape/ruby-grape.github.io/blob/master/users/index.md). + * [Artsy.net](https://www.artsy.net) has a [public API](https://developers.artsy.net) built with Grape. * [Devex.com](https://www.devex.com) is a media platform for the global development community. We use Grape internally and expose some endpoints to partners. +* [Screenhero](https://screenhero.com), now sadly defunct, offers screensharing with real-time interactivity. Screenhero made extensive use of Grape for its private and public APIs (*e.g.* as used by Slack's integration). +* [Meeteor](http://www.meeteor.com), Meeteor is a web app that helps you leverage your meetings to +drive productivity, build a healthy company culture, and achieve greater +results. Meeteor uses Grape API to support its mobile and android UIs + various other extensions like extensions for outlook, google calendar, hipchat, slack. +* [GitLab](https://gitlab.com), GitLab is an open-core web application that includes issue tracking, merge requests, Continuous Integration, and more. Community Edition is [fully open source](https://gitlab.com/gitlab-org/gitlab-ce) and includes an API built using Grape. +* [Mapotempo](https://www.mapotempo.com/) publishes Open Source route planning and optimization solutions. Grape is used on the majority of the company projects which expose an API. ### Contribute