devise-ios-rails 1.0.0

data/spec/dummy/README.md

@@ -0,0 +1,225 @@
+Open Source Devise iOS Rails Backend
+=================================
+
+[![Circle CI](https://circleci.com/gh/netguru/devise-ios-rails-example.svg?style=svg)](https://circleci.com/gh/netguru/devise-ios-rails-example)
+[![Code Climate](https://codeclimate.com/repos/54734062e30ba07474053280/badges/398895b59d76c0c16cd2/gpa.svg)](https://codeclimate.com/repos/54734062e30ba07474053280/feed)
+[![Test Coverage](https://codeclimate.com/repos/54734062e30ba07474053280/badges/398895b59d76c0c16cd2/coverage.svg)](https://codeclimate.com/repos/54734062e30ba07474053280/feed)
+[![Dependency](https://img.shields.io/gemnasium/netguru/devise-ios-rails-example.svg)](https://gemnasium.com/netguru/devise-ios-rails-example)
+
+A rails backend for demonstrating how [Devise for iOS][ios_devise] works.
+
+How to use
+==========
+
+After a [successfull installation](#setup) you can use `localhost:3000/doc` to trigger request at some particular endpoints.
+
+Demo App
+========
+
+We've setup for you a demo of this server at [https://devise-ios-rails-example.herokuapp.com](https://devise-ios-rails-example.herokuapp.com). You can test how it works with either using dynamically generated swagger [docs][heroku_docs] or by using some old school curl commands:
+
+register a user
+
+```bash
+$ curl \
+-H 'Accept: application/json' \
+-H 'Content-Type: application/json' \
+-X POST -d '{ "user": { "email": "user@example.com", "password": "1234" } }' \
+https://devise-ios-rails-example.herokuapp.com/v1/users
+```
+
+in return you will get a newly created user
+
+```json
+{
+  "id": 2,
+  "email": "user@example.com",
+  "created_at": "2014-12-09T16:17:46.170Z",
+  "updated_at": "2014-12-09T16:17:46.170Z",
+  "authentication_token": "2-D9jBtnAPcP8fppzJAL"
+}
+```
+
+login a user
+
+```bash
+$ curl \
+-H 'Accept: application/json' \
+-H 'Content-Type: application/json' \
+-X POST -d '{ "user": { "email": "user@example.com", "password": "1234" } }' \
+https://devise-ios-rails-example.herokuapp.com/v1/users/sign_in
+```
+
+you will get again the same data:
+
+```json
+{
+  "id": 2,
+  "email": "user@example.com",
+  "created_at": "2014-12-09T16:17:46.170Z",
+  "updated_at": "2014-12-09T16:17:46.170Z",
+  "authentication_token": "2-D9jBtnAPcP8fppzJAL"
+}
+```
+
+to make request to resources that are only available for registered users, you need to pass email and authentication token in your headers all the time:
+
+```bash
+$ curl \
+-H 'Accept: application/json' \
+-H 'Content-Type: application/json' \
+-H 'X-User-Email: user@example.com' \
+-H 'X-User-Token: 2-D9jBtnAPcP8fppzJAL' \
+-X GET https://devise-ios-rails-example.herokuapp.com/v1/secret_spaces/new
+```
+
+response: `{ "id": null, "text": null, "created_at": null, "updated_at": null }`
+
+in order to check how password reset works:
+
+```bash
+$ curl \
+-H 'Accept: application/json' \
+-H 'Content-Type: application/json' \
+-X POST -d '{ "user": { "email": "user@example.com" } }' \
+https://devise-ios-rails-example.herokuapp.com/v1/users/password
+```
+
+you receive response status 204 (no content). In the meantime, server sends instructions on how to reset the password, which you should follow. On heroku we use `letter_opener_web` gem therefore those emails are stored at [https://devise-ios-rails-example.herokuapp.com/letter_opener](https://devise-ios-rails-example.herokuapp.com/letter_opener).
+
+Here is a complete list of paths:
+
+- Useful Devise paths
+
+```
+               login - POST   /v1/users/sign_in
+               login - GET    /v1/users/sign_in
+            register - POST   /v1/users
+         update user - PUT    /v1/users
+         delete user - DELETE /v1/users
+change user password - PUT    /v1/users/password
+      password reset - POST   /v1/users/password
+```
+
+- Secret Spaces for demonstration purposes
+
+```
+               index - GET    /v1/secret_spaces
+                show - GET    /v1/secret_spaces/:id
+                 new - GET    /v1/secret_spaces/new
+              create - POST   /v1/secret_spaces
+                edit - GET    /v1/secret_spaces/:id/edit
+              update - PUT    /v1/secret_spaces/:id
+              delete - DELETE /v1/secret_spaces/password/:id
+```
+
+Requirements
+============
+
+| Name |  Version |
+| :--: | :---: |
+| [Ruby][ruby] | 2.1.5 |
+| [Ruby on Rails][rails] | 4.1.8 |
+
+You can find some guidelines on how to install above [on mac][mac_guidelines] and [on ubuntu][ubuntu_guidelines]
+
+#### Optional (recommended)
+
+- git (mac - `brew install git`, ubuntu - `apt-get install git`)
+
+
+Setup
+=====
+
+- clone repo to your local machine `git clone https://github.com/netguru/devise-ios-rails.git ./devise-ios-rails`
+
+Database config
+---------------
+
+- copy config/database.yml.sample to config/database.yml `cp config/database.yml.sample to config/database.yml`
+- fill in your appropriate details in your database.yml config file, example:
+
+```yaml
+development:
+  adapter: sqlite3
+  host: localhost
+  database: devise_ios_rails_development.sqlite3
+  username: devise_ios_rails
+```
+
+- and create a database:
+
+```bash
+rake db:create
+rake db:schema:load
+rake db:test:prepare
+```
+
+- create seed data with `rake db:seed`
+
+this will create:
+
+* users:
+    - registered user - ios@example.com / alcatraz
+
+Environment config
+------------------
+
+- copy .env.sample to .env `cp .env.sample .env`
+- fill your domain name and url - in local environment it's normally `localhost` and `http://localhost:3000` respectively.
+- you will need to generate your own `SECRET_KEY_BASE` by running `rake secret` and pasting the output into .env file.
+- you can omit Rollbar config in development environment.
+
+Start Server
+------------
+
+Before you start app be sure that PostgreSQL is already running. Then start Rails server on default port with `rails server`.
+
+Tests
+=====
+
+- you run tests with `spring rspec`
+
+Other tools
+===========
+
+Spring
+------
+
+You can use [Spring][spring] to speed up specs, rake tasks and rails commands.
+
+Just add `spring` before commands like `rspec`, `rake`, `rails`
+
+Contribution
+============
+
+First, thank you for contributing!
+
+Here a few guidelines to follow:
+
+- we follow [Ruby Style Guide][ruby_style_guides].
+- you can use [rubocop][rubocop] which can be easily integrated with popular editors. ([our rubocop config][rubocop_config])
+- keep gems up to date - you can use [gemsurance][gemsurance] to check for outdated gems - simply run `bundle exec gemsurance`.
+- write tests
+- make sure the entire test suite passes
+- make sure rubocop passes, our config
+- open a pull request on GitHub
+- [squash your commits][squash_commits] after receiving feedback
+
+Copyright  2014 © [Netguru][netguru_url], released under the New BSD License
+
+[heroku_docs]: https://devise-ios-rails-example.herokuapp.com/doc
+[ruby]: https://www.ruby-lang.org
+[rails]: http://www.rubyonrails.org
+[postgres]: http://www.postgresql.org
+[ios_devise]: https://github.com/netguru/devise-ios
+[mac_guidelines]: https://gorails.com/setup/osx/10.10-yosemite
+[ubuntu_guidelines]: https://gorails.com/setup/ubuntu/14.10
+[postgres_guidelines]: https://wiki.postgresql.org/wiki/Detailed_installation_guides
+[spring]: https://github.com/rails/spring
+[ruby_style_guides]: https://github.com/bbatsov/ruby-style-guide
+[rubocop]: https://github.com/bbatsov/rubocop
+[rubocop_config]: https://github.com/netguru/hound/blob/master/config/rubocop.yml
+[gemsurance]: https://github.com/appfolio/gemsurance
+[squash_commits]: http://blog.steveklabnik.com/posts/2012-11-08-how-to-squash-commits-in-a-github-pull-request
+[netguru_url]: https://netguru.co

data/spec/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Rails.application.load_tasks

data/spec/dummy/app/assets/javascripts/active_admin.js.coffee

@@ -0,0 +1 @@
+#= require active_admin/base

data/spec/dummy/app/assets/javascripts/secret_spaces.coffee

@@ -0,0 +1,3 @@
+# Place all the behaviors and hooks related to the matching controller here.
+# All this logic will automatically be available in application.js.
+# You can use CoffeeScript in this file: http://coffeescript.org/

data/spec/dummy/app/assets/stylesheets/active_admin.css.scss

@@ -0,0 +1,17 @@
+// SASS variable overrides must be declared before loading up Active Admin's styles.
+//
+// To view the variables that Active Admin provides, take a look at
+// `app/assets/stylesheets/active_admin/mixins/_variables.css.scss` in the
+// Active Admin source.
+//
+// For example, to change the sidebar width:
+// $sidebar-width: 242px;
+
+// Active Admin's got SASS!
+@import "active_admin/mixins";
+@import "active_admin/base";
+
+// Overriding any non-variable SASS must be done after the fact.
+// For example, to change the default status-tag color:
+//
+//   .status_tag { background: #6090DB; }

data/spec/dummy/app/assets/stylesheets/scaffolds.css.scss

@@ -0,0 +1,69 @@
+body {
+  background-color: #fff;
+  color: #333;
+  font-family: verdana, arial, helvetica, sans-serif;
+  font-size: 13px;
+  line-height: 18px;
+}
+
+p, ol, ul, td {
+  font-family: verdana, arial, helvetica, sans-serif;
+  font-size: 13px;
+  line-height: 18px;
+}
+
+pre {
+  background-color: #eee;
+  padding: 10px;
+  font-size: 11px;
+}
+
+a {
+  color: #000;
+  &:visited {
+    color: #666;
+  }
+  &:hover {
+    color: #fff;
+    background-color: #000;
+  }
+}
+
+div {
+  &.field, &.actions {
+    margin-bottom: 10px;
+  }
+}
+
+#notice {
+  color: green;
+}
+
+.field_with_errors {
+  padding: 2px;
+  background-color: red;
+  display: table;
+}
+
+#error_explanation {
+  width: 450px;
+  border: 2px solid red;
+  padding: 7px;
+  padding-bottom: 0;
+  margin-bottom: 20px;
+  background-color: #f0f0f0;
+  h2 {
+    text-align: left;
+    font-weight: bold;
+    padding: 5px 5px 5px 15px;
+    font-size: 12px;
+    margin: -7px;
+    margin-bottom: 0px;
+    background-color: #c00;
+    color: #fff;
+  }
+  ul li {
+    font-size: 12px;
+    list-style: square;
+  }
+}

data/spec/dummy/app/assets/stylesheets/secret_spaces.css.scss

@@ -0,0 +1,3 @@
+// Place all the styles related to the secret_spaces controller here.
+// They will automatically be included in application.css.
+// You can use Sass (SCSS) here: http://sass-lang.com/

data/spec/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,3 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery with: :exception
+end

data/spec/dummy/app/controllers/secret_spaces_controller.rb

@@ -0,0 +1,49 @@
+class SecretSpacesController < ApplicationController
+  acts_as_token_authentication_handler_for User
+
+  before_action :set_secret_space, only: [:show, :edit, :update, :destroy]
+
+  respond_to :html, :json
+
+  def index
+    @secret_spaces = SecretSpace.all
+    respond_with(@secret_spaces)
+  end
+
+  def show
+    respond_with(@secret_space)
+  end
+
+  def new
+    @secret_space = SecretSpace.new
+    respond_with(@secret_space)
+  end
+
+  def edit
+  end
+
+  def create
+    @secret_space = SecretSpace.new(secret_space_params)
+    @secret_space.save
+    respond_with(@secret_space)
+  end
+
+  def update
+    @secret_space.update(secret_space_params)
+    respond_with(@secret_space)
+  end
+
+  def destroy
+    @secret_space.destroy
+    respond_with(@secret_space)
+  end
+
+  private
+    def set_secret_space
+      @secret_space = SecretSpace.find(params[:id])
+    end
+
+    def secret_space_params
+      params.require(:secret_space).permit(:text)
+    end
+end

data/spec/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/spec/dummy/app/helpers/secret_spaces_helper.rb

@@ -0,0 +1,2 @@
+module SecretSpacesHelper
+end

data/spec/dummy/app/models/secret_space.rb

@@ -0,0 +1,3 @@
+class SecretSpace < ActiveRecord::Base
+  validates :text, presence: true
+end

data/spec/dummy/app/models/user.rb

@@ -0,0 +1,5 @@
+class User < ActiveRecord::Base
+  acts_as_token_authenticatable
+  devise :database_authenticatable, :registerable,
+         :recoverable, :rememberable, :validatable
+end

data/spec/dummy/app/serializers/secret_space_serializer.rb

@@ -0,0 +1,3 @@
+class SecretSpaceSerializer < ActiveModel::Serializer
+  attributes :id
+end

data/spec/dummy/app/serializers/user_serializer.rb

@@ -0,0 +1,8 @@
+class UserSerializer < ActiveModel::Serializer
+  attributes \
+    :id,
+    :email,
+    :authentication_token,
+    :created_at,
+    :updated_at
+end

data/spec/dummy/app/serializers/v1/base_serializer.rb

@@ -0,0 +1,5 @@
+module V1
+  class BaseSerializer < ActiveModel::Serializer
+
+  end
+end

data/spec/dummy/app/serializers/v1/user_serializer.rb

@@ -0,0 +1,4 @@
+module V1
+  class UserSerializer < ::UserSerializer
+  end
+end

data/spec/dummy/app/views/secret_spaces/_form.html.haml

@@ -0,0 +1,13 @@
+= form_for @secret_space do |f|
+  - if @secret_space.errors.any?
+    #error_explanation
+      %h2= "#{pluralize(@secret_space.errors.count, "error")} prohibited this secret_space from being saved:"
+      %ul
+        - @secret_space.errors.full_messages.each do |msg|
+          %li= msg
+
+  .field
+    = f.label :text
+    = f.text_field :text
+  .actions
+    = f.submit 'Save'