swagger-api 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ddaa358b2058ec6147ee67678e0fae63b9c1728e6658da413e6e65a6c8961e9f
-  data.tar.gz: 778961a47e48528e655e976456141aa66af6e64d9f8b6dc4da232f052c0b89e4
+  metadata.gz: b579ec62c5fa7318e04f098dc340ab925431588e05b28554509c6bd83d2b881f
+  data.tar.gz: 1e4c0e97b6414775da7fcd11703e5f7d4f2d1c825e5434c426d5d22d3f219abe
 SHA512:
-  metadata.gz: 1ad41c3cdd090efd71bfe97577e2da3bc96485b2674231f49e77a605202e8ddfbb07a81176ddf821158d90b475716f123e60aa8a6c93dd822a645c38586f70c4
-  data.tar.gz: b4d2820a576c040f26caa413a7c910d13d65df515f2216e5cce8ae9addaf330110274a5382edd626d73ab08757cbf437aa38071368623493898be81427484df9
+  metadata.gz: 279b6a523ef0cd39a4c652177e47c2e46596a9ddcb27ed91f7e6ab51ed9169f126301f3a9e0a404e9abf33960fac7a277b18c989bcdeea1e6c697b3a1ebc23fd
+  data.tar.gz: 98f27a8c8aa1c4a9154bc69963831b65e757620c2c6f571a28a7f4a2fae192340033967780263f7423b9cc347a72311a85957cb85578f21c5c792dae9bafe8b4

data/.gitlab-ci.yml

@@ -0,0 +1,65 @@
+stages:
+  - build
+  - deploy
+  - test
+  - push
+
+rspec:
+  stage: test
+  image: registry.gitlab.com/fullmeasure/public/docker/rails-mysql-node:latest
+  variables:
+    MYSQL_ROOT_PASSWORD: 'root'
+    DB_ROOT_PASS: 'root'
+    RAILS_ENV: test
+  services:
+    - docker:dind
+    - mysql:5.6
+    - redis:latest
+  before_script:
+    - bundle install --quiet
+    - bundle exec rake db:create >> /dev/null
+    - bundle exec rake db:migrate
+    - npm install -g bower --quiet >> /dev/null
+    - npm install -g yarn --quiet >> /dev/null
+    - bower install --allow-root --silent
+    - yarn install --silent
+    - bundle exec rake assets:yarn_install
+  script:
+    - bundle exec rspec
+  artifacts:
+    name: "$CI_COMMIT_REF_NAME-$CI_COMMIT_SHA"
+    when: always
+    expire_in: 1 week
+    paths:
+      - coverage/
+  only:
+    - /^master$/
+
+codequality:
+  stage: test
+  allow_failure: true
+  image: docker:latest
+  variables:
+    DOCKER_DRIVER: overlay
+  services:
+    - docker:dind
+  script:
+    - docker pull codeclimate/codeclimate
+    - docker run --env CODECLIMATE_CODE="$PWD" --volume "$PWD":/code --volume /var/run/docker.sock:/var/run/docker.sock --volume /tmp/cc:/tmp/cc codeclimate/codeclimate:0.69.0 init
+    - docker run --env CODECLIMATE_CODE="$PWD" --volume "$PWD":/code --volume /var/run/docker.sock:/var/run/docker.sock --volume /tmp/cc:/tmp/cc codeclimate/codeclimate:0.69.0 analyze -f json > codeclimate.json || true
+  artifacts:
+    paths: [codeclimate.json]
+
+
+deploy:
+  stage: deploy
+  retry: 2
+  image: registry.gitlab.com/fullmeasure/public/docker/rails-mysql-node:latest
+  before_script:
+    - gem install gem-release
+    - gem bump patch
+    - gem build swagger-api
+  script:
+    - gem push swagger-api
+  only:
+    - /(^master$)/

data/README.md

@@ -1,8 +1,6 @@
 # Swagger::Api
 
-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/swagger/api`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+A gem to make swagger documentation easier to create
 
 ## Installation
 
@@ -22,7 +20,11 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Create a swagger.yml and place it in you gem directory (see swagger.yml in root directory for an example)
+
+    $ bundle exec rake swagger:api
+    
+This will create 
 
 ## Development
 
@@ -32,7 +34,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/swagger-api. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://gitlab.com/fullmeasure/swagger-api/swagger-api. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## License
 

data/lib/swagger/api.rb

@@ -12,6 +12,8 @@ module Swagger
 
     def self.create
       @config ||= {
+        openapi: '3.0.0',
+        security: [{api_key: []}],
         info: info,
         servers: [{url: server_url}],
         paths: Paths.new(controllers: config.controllers).create,

data/lib/swagger/api/version.rb

@@ -1,5 +1,5 @@
 module Swagger
   module Api
-    VERSION = "0.1.4"
+    VERSION = "0.1.5"
   end
 end

data/swagger.yml

@@ -0,0 +1,46 @@
+info:
+  version: 1.0.0-oas
+  title: FME Integrations
+  description: Student basic information and audiences
+servers:
+  cm_production:
+    url: https://cm.fullmeasureed.com/api/webservices
+  cm_stage:
+    url: https://cm.stage.fullmeasureed.com/api/webservices
+  iwu_production:
+    url: https://iwu.fullmeasureed.com/api/webservices
+  iwu_stage:
+    url: https://iwu.stage.fullmeasureed.com/api/webservices
+  development:
+    url: https://localhost:3000/api/webservices
+controllers:
+  - name: Api::WebServices::StudentsController
+    model: Student
+    columns:
+      only:
+        - id
+        - first_name
+        - last_name
+        - email
+        - mobile_phone_number
+        - external_student_id
+        - type
+
+      required:
+        - id
+        - first_name
+        - last_name
+        - email
+        - mobile_phone_number
+        - external_student_id
+        - type
+
+  - name: Api::WebServices::AudiencesController
+    model: Audience
+
+  - name: Api::WebServices::AudienceStudentsController
+    actions:
+      except:
+        - update
+    model: AudienceStudent
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: swagger-api
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Full Measure Education
@@ -75,6 +75,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".gitlab-ci.yml"
 - ".rspec"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
@@ -103,6 +104,7 @@ files:
 - lib/swagger/api/version.rb
 - lib/swagger/railtie.rb
 - swagger-api.gemspec
+- swagger.yml
 homepage: https://gitlab.com/fullmeasure/public/swagger-api/swagger-api
 licenses:
 - MIT