trogdir_api 0.3.4 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f5eae02ebddb3a522c550819032628f91da2ec72
-  data.tar.gz: 45d616eaa836d702cdd1e87a1811134da5e33aff
+  metadata.gz: 605eb6e0918e27762f8db0b60ecde7e523d7214e
+  data.tar.gz: b60777544ce916decf1b539b42a7dfa42b1a0b6f
 SHA512:
-  metadata.gz: 365e67b6dda2b2a5512f2c764ebd05c48b03902a10be9bd47a7c662f6e823260e9fdfc47e481a650b461050dd92742834f489a28171a9bbf167d804939b228bd
-  data.tar.gz: 9213a1271531df3af42aa4d27428aeed37ab832f1541b75494ec46332842c63840d247fc6accfa23aa7a5cfbdaf89a61fa1f900dcfd34197f9f15a5f97b243a7
+  metadata.gz: 3e2607a7cfaeba753516473acf9a9ba9882ee1d74266b467866e8b55552df1d049707569e2355a240ef7c83b7643de6d0c5c02e599e72ff9c84b6ecdcc4ab63e
+  data.tar.gz: 9653d120b00b42683a075e54b50725500a35d4dd8f0e6e665cda88de726f8bcab5ad981dfc49f6cacc1976c91cc56eb23463028cc62518b0a850a68ad38ed761

data/README.md

@@ -1,3 +1,58 @@
 Trogdir API [![Build Status](https://travis-ci.org/biola/trogdir-api.png)](https://travis-ci.org/biola/trogdir-api)
 ===========
 RESTful APIs for the Trogdir directory project.
+
+Requirements
+------------
+- [Ruby](https://www.ruby-lang.org)
+- [MongoDB](https://www.mongodb.org)
+- [Rack web server](http://rack.github.io)
+
+Installation
+------------
+```bash
+git clone git@github.com:biola/trogdir-api.git
+cd trogdir-api
+bundle install
+cp config/mongoid.yml.example config/mongoid.yml
+cp config/blazing.rb.example config/blazing.rb
+cp config/newrelic.yml.example config/newrelic.yml
+```
+
+Configuration
+-------------
+- Edit `config/mongoid.yml` accordingly.
+- Edit `config/blazing.rb` accordingly.
+- Edit `config/newrelic.yml` accordingly.
+
+Deployment
+----------
+```bash
+blazing setup [target name in blazing.rb]
+git push [target name in blazing.rb]
+```
+
+Console
+-------
+To launch a console, `cd` into the app directory and run `irb -r ./config/environment.rb`
+
+GUI Frontend
+------------
+See [three-keepers](https://github.com/biola/three-keepers) for a frontend GUI to the trogdir-api data.
+
+Consuming the API
+-----------------
+See [trogdir-api-client](https://github.com/biola/trogdir-api-client) for details on consuming the API.
+
+Client (Syncinator) Setup
+------------
+There is currently no GUI for creating syncinators. To create a new client, lanunch the console and run the following command.
+```ruby
+Syncinator.create name: 'my-app', queue_changes: false
+```
+This will automatically generate an `access_id` and `secret_key` that you will need to provide to `trogdir-api-client` in your application so that it can authhenticate with `trogdir-api`
+
+_Note: for details on whether or not you want to set `queue_changes`, see **Change Tracking and Syncing** below._
+Change Tracking and Syncing
+---------------------------
+__TODO__

data/config.ru

@@ -17,4 +17,6 @@ use Rack::CommonLogger, file
 
 use Pinglish, &TrogdirAPI.pinglish_block
 
-run Trogdir::API
+map ENV['PUMA_RELATIVE_URL_ROOT'] || '/' do
+  run Trogdir::API
+end

data/config/blazing.rb

@@ -1,6 +1,5 @@
-target :'ruby2.staging', 'adamc7@ruby2.staging.biola.edu:/srv/rack/trogdir-api', rails_env: 'staging'
-target :'ruby5a.prod',   'adamc7@ruby5a.prod.biola.edu:/srv/rack/trogdir-api',   rails_env: 'production'
-target :'ruby5b.prod',   'adamc7@ruby5b.prod.biola.edu:/srv/rack/trogdir-api',   rails_env: 'production'
+target :'proda',   'devinh1@ruby3a.prod.biola.edu:/srv/rack/trogdir-api',    rails_env: 'production'
+target :'prodb',   'devinh1@ruby3b.prod.biola.edu:/srv/rack/trogdir-api',    rails_env: 'production'
 
 env_scripts '/etc/profile'
 

data/config/blazing.rb.example

@@ -1,5 +1,5 @@
-target :'ruby2.staging', 'johnd0@ruby1.staging.biola.edu:/srv/rack/trogdir-api',  rails_env: 'staging'
-target :'ruby3a.prod',   'johnd0@ruby3a.prod.biola.edu:/srv/rack/trodgir-api',    rails_env: 'production'
+target :'ruby2.staging', 'johnd0@ruby2.staging.biola.edu:/srv/rack/trogdir-api',  rails_env: 'staging'
+target :'ruby3a.prod',   'johnd0@ruby3a.prod.biola.edu:/srv/rack/trogdir-api',    rails_env: 'production'
 target :'ruby3b.prod',   'johnd0@ruby3b.prod.biola.edu:/srv/rack/trogdir-api',    rails_env: 'production'
 
 env_scripts '/etc/profile'

data/config/mongoid.yml

@@ -11,3 +11,25 @@ test:
       database: trogdir_test
       hosts:
         - localhost:27017
+
+staging:
+  sessions:
+    default:
+      database: trogdir
+      hosts:
+        - mongo1.staging.biola.edu:27017
+        - mongo2.staging.biola.edu:27017
+        - mongo3.staging.biola.edu:27017
+      username: trogdir
+      password: "*************"
+
+production:
+  sessions:
+    default:
+      database: trogdir
+      hosts:
+        - mongo1.prod.biola.edu:27017
+        - mongo2.prod.biola.edu:27017
+        - mongo3.prod.biola.edu:27017
+      username: trogdir
+      password: "*************"

data/lib/trogdir/versions/v1/entities/person.rb

@@ -45,6 +45,7 @@ module Trogdir
         :employee_type,
         :full_time,
         :pay_type,
+        :job_ct,
 
         ids: [
           :id,

data/lib/trogdir/versions/v1/people_api.rb

@@ -79,6 +79,7 @@ module Trogdir
           optional :employee_type, type: Symbol
           optional :full_time, type: Boolean
           optional :pay_type, type: Symbol
+          optional :job_ct, type: Integer
         end
         post do
           present Person.create!(clean_params), with: PersonEntity

data/lib/trogdir_api/version.rb

@@ -1,3 +1,3 @@
 module TrogdirAPI
-  VERSION = '0.3.4'
+  VERSION = '0.4.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: trogdir_api
 version: !ruby/object:Gem::Version
-  version: 0.3.4
+  version: 0.4.0
 platform: ruby
 authors:
 - Adam Crownoble
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-24 00:00:00.000000000 Z
+date: 2015-12-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: api-auth
@@ -150,7 +150,6 @@ files:
 - config/environment.rb
 - config/mongoid.yml
 - config/mongoid.yml.example
-- config/newrelic.yml
 - config/newrelic.yml.example
 - lib/trogdir/api.rb
 - lib/trogdir/helpers/authentication_helpers.rb

data/config/newrelic.yml

@@ -1,227 +0,0 @@
-#
-# This file configures the New Relic Agent.  New Relic monitors
-# Ruby, Java, .NET, PHP, and Python applications with deep visibility and low overhead.
-# For more information, visit www.newrelic.com.
-#
-# Generated May 01, 2014
-#
-# This configuration file is custom generated for Biola University
-
-
-# Here are the settings that are common to all environments
-common: &default_settings
-  # ============================== LICENSE KEY ===============================
-
-  # You must specify the license key associated with your New Relic
-  # account.  This key binds your Agent's data to your account in the
-  # New Relic service.
-  license_key: # set in newrelic.yml
-
-  # Agent Enabled (Ruby/Rails Only)
-  # Use this setting to force the agent to run or not run.
-  # Default is 'auto' which means the agent will install and run only
-  # if a valid dispatcher such as Mongrel is running.  This prevents
-  # it from running with Rake or the console.  Set to false to
-  # completely turn the agent off regardless of the other settings.
-  # Valid values are true, false and auto.
-  #
-  # agent_enabled: auto
-
-  # Application Name Set this to be the name of your application as
-  # you'd like it show up in New Relic. The service will then auto-map
-  # instances of your application into an "application" on your
-  # dashboard page. If you want to map this instance into multiple
-  # apps, like "AJAX Requests" and "All UI" then specify a semicolon
-  # separated list of up to three distinct names, or a yaml list.
-  # Defaults to the capitalized RAILS_ENV or RACK_ENV (i.e.,
-  # Production, Staging, etc)
-  #
-  # Example:
-  #
-  #   app_name:
-  #       - Ajax Service
-  #       - All Services
-  #
-  app_name: trogdir-api
-
-  # When "true", the agent collects performance data about your
-  # application and reports this data to the New Relic service at
-  # newrelic.com. This global switch is normally overridden for each
-  # environment below. (formerly called 'enabled')
-  monitor_mode: true
-
-  # Developer mode should be off in every environment but
-  # development as it has very high overhead in memory.
-  developer_mode: false
-
-  # The newrelic agent generates its own log file to keep its logging
-  # information separate from that of your application. Specify its
-  # log level here.
-  log_level: info
-
-  # Optionally set the path to the log file This is expanded from the
-  # root directory (may be relative or absolute, e.g. 'log/' or
-  # '/var/log/') The agent will attempt to create this directory if it
-  # does not exist.
-  # log_file_path: 'log'
-
-  # Optionally set the name of the log file, defaults to 'newrelic_agent.log'
-  # log_file_name: 'newrelic_agent.log'
-
-  # The newrelic agent communicates with the service via https by default.  This
-  # prevents eavesdropping on the performance metrics transmitted by the agent.
-  # The encryption required by SSL introduces a nominal amount of CPU overhead,
-  # which is performed asynchronously in a background thread.  If you'd prefer
-  # to send your metrics over http uncomment the following line.
-  # ssl: false
-
-  #============================== Browser Monitoring ===============================
-  # New Relic Real User Monitoring gives you insight into the performance real users are
-  # experiencing with your website. This is accomplished by measuring the time it takes for
-  # your users' browsers to download and render your web pages by injecting a small amount
-  # of JavaScript code into the header and footer of each page.
-  browser_monitoring:
-      # By default the agent automatically injects the monitoring JavaScript
-      # into web pages. Set this attribute to false to turn off this behavior.
-      auto_instrument: true
-
-  # Proxy settings for connecting to the New Relic server.
-  #
-  # If a proxy is used, the host setting is required.  Other settings
-  # are optional. Default port is 8080.
-  #
-  # proxy_host: hostname
-  # proxy_port: 8080
-  # proxy_user:
-  # proxy_pass:
-
-  # The agent can optionally log all data it sends to New Relic servers to a
-  # separate log file for human inspection and auditing purposes. To enable this
-  # feature, change 'enabled' below to true.
-  # See: https://newrelic.com/docs/ruby/audit-log
-  audit_log:
-    enabled: false
-
-  # Tells transaction tracer and error collector (when enabled)
-  # whether or not to capture HTTP params.  When true, frameworks can
-  # exclude HTTP parameters from being captured.
-  # Rails: the RoR filter_parameter_logging excludes parameters
-  # Java: create a config setting called "ignored_params" and set it to
-  #     a comma separated list of HTTP parameter names.
-  #     ex: ignored_params: credit_card, ssn, password
-  capture_params: false
-
-  # Transaction tracer captures deep information about slow
-  # transactions and sends this to the New Relic service once a
-  # minute. Included in the transaction is the exact call sequence of
-  # the transactions including any SQL statements issued.
-  transaction_tracer:
-
-    # Transaction tracer is enabled by default. Set this to false to
-    # turn it off. This feature is only available at the Professional
-    # and above product levels.
-    enabled: true
-
-    # Threshold in seconds for when to collect a transaction
-    # trace. When the response time of a controller action exceeds
-    # this threshold, a transaction trace will be recorded and sent to
-    # New Relic. Valid values are any float value, or (default) "apdex_f",
-    # which will use the threshold for an dissatisfying Apdex
-    # controller action - four times the Apdex T value.
-    transaction_threshold: apdex_f
-
-    # When transaction tracer is on, SQL statements can optionally be
-    # recorded. The recorder has three modes, "off" which sends no
-    # SQL, "raw" which sends the SQL statement in its original form,
-    # and "obfuscated", which strips out numeric and string literals.
-    record_sql: obfuscated
-
-    # Threshold in seconds for when to collect stack trace for a SQL
-    # call. In other words, when SQL statements exceed this threshold,
-    # then capture and send to New Relic the current stack trace. This is
-    # helpful for pinpointing where long SQL calls originate from.
-    stack_trace_threshold: 0.500
-
-    # Determines whether the agent will capture query plans for slow
-    # SQL queries.  Only supported in mysql and postgres.  Should be
-    # set to false when using other adapters.
-    # explain_enabled: true
-
-    # Threshold for query execution time below which query plans will
-    # not be captured.  Relevant only when `explain_enabled` is true.
-    # explain_threshold: 0.5
-
-  # Error collector captures information about uncaught exceptions and
-  # sends them to New Relic for viewing
-  error_collector:
-
-    # Error collector is enabled by default. Set this to false to turn
-    # it off. This feature is only available at the Professional and above
-    # product levels.
-    enabled: true
-
-    # Rails Only - tells error collector whether or not to capture a
-    # source snippet around the place of the error when errors are View
-    # related.
-    capture_source: true
-
-    # To stop specific errors from reporting to New Relic, set this property
-    # to comma-separated values.  Default is to ignore routing errors,
-    # which are how 404's get triggered.
-    ignore_errors: "ActionController::RoutingError,Sinatra::NotFound"
-
-  # If you're interested in capturing memcache keys as though they
-  # were SQL uncomment this flag. Note that this does increase
-  # overhead slightly on every memcached call, and can have security
-  # implications if your memcached keys are sensitive
-  # capture_memcache_keys: true
-
-# Application Environments
-# ------------------------------------------
-# Environment-specific settings are in this section.
-# For Rails applications, RAILS_ENV is used to determine the environment.
-# For Java applications, pass -Dnewrelic.environment <environment> to set
-# the environment.
-
-# NOTE if your application has other named environments, you should
-# provide newrelic configuration settings for these environments here.
-
-development:
-  <<: *default_settings
-  # Turn off communication to New Relic service in development mode (also
-  # 'enabled').
-  # NOTE: for initial evaluation purposes, you may want to temporarily
-  # turn the agent on in development mode.
-  monitor_mode: false
-
-  # Rails Only - when running in Developer Mode, the New Relic Agent will
-  # present performance information on the last 100 transactions you have
-  # executed since starting the mongrel.
-  # NOTE: There is substantial overhead when running in developer mode.
-  # Do not use for production or load testing.
-  developer_mode: true
-
-  # Enable textmate links
-  # textmate: true
-
-test:
-  <<: *default_settings
-  # It almost never makes sense to turn on the agent when running
-  # unit, functional or integration tests or the like.
-  monitor_mode: false
-
-# Turn on the agent in production for 24x7 monitoring. NewRelic
-# testing shows an average performance impact of < 5 ms per
-# transaction, you can leave this on all the time without
-# incurring any user-visible performance degradation.
-production:
-  <<: *default_settings
-  monitor_mode: true
-
-# Many applications have a staging environment which behaves
-# identically to production. Support for that environment is provided
-# here.  By default, the staging environment has the agent turned on.
-staging:
-  <<: *default_settings
-  monitor_mode: true
-  # app_name: My Application (Staging)