djspinmonkey / community_service_examples

A selection of sample service applications using the CommunityService gem.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Community Service: Example Services

Overview

This is a set of services based on the Community Service gem for service discovery and communication. Though they are called "Example" services, many of them could be taken as-is and dropped in to production, though it is likely that you will end up wanting to customize them down the road. Others, such as the WiggleService, are simply meant to illustrate common service patterns (in that case, a simple CRUD service).

Services

  • UserService - Provides a basic User model. NOT YET IMPLEMENTED
  • LoginService - Provides a login page and tracks sessions. NOT YET IMPLEMENTED
  • PermissionService - Tracks authorization data. NOT YET IMPLEMENTED, LIKELY TO REQUIRE CUSTOMIZATION
  • WiggleService - A simple CRUD-based service.

Each service also has a corresponding client gem (eg, "wiggle_client").

Creating A New Service

There's a Rails template in this directory which all the example services were built with. That said, as long as your services expose the correct API and are acceptably performant, it doesn't really matter what the internal implementations look like. Heck, write 'em in Java if you want (or, more likely, if you need the performance).

Running All The Services

Locally on your machine

TODO: There should be a way to do this -- probably a script in the base directory?

For reals, in production

That's up to you! It really depends on your individual setup; there probably isn't a sane way to create a generic deploy strategy here. If you need a hand with this, you might want to get a more experienced friend (or hire a consultant) to help you out.

About

A selection of sample service applications using the CommunityService gem.


Languages

Language:Ruby 80.2%Language:HTML 14.4%Language:SCSS 1.7%Language:CSS 1.5%Language:JavaScript 1.5%Language:CoffeeScript 0.7%