reiformslive-ruby 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b67d79bcd634191ddb9f3e3e8a846dde46ef59bf
+  data.tar.gz: bdbc5a68ca3be8d81148c0ff7a67ec0237abee50
+SHA512:
+  metadata.gz: 6eb12b4aaeeafd3c38b0bae62789d731d281f82b5858bc7e36b3987fd3ea7e5799f1129d64baae48361c3f15decd274a177206c7c475fd07a823388b08eb98bf
+  data.tar.gz: 3a4cb0aaa9603977f63f0409fd655adbf339c38d29c9193a549cba2f64fc324d740c3c86cdb363093bbaee5e8d2021a9f1a07b0d16d87c79c7a92bceef803ef1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at milanese.david@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,20 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in reisa-wrapper.gemspec
+gemspec
+
+group :development do
+  gem 'guard'
+  gem 'guard-rspec'   , require: false
+  gem 'guard-bundler' , require: false
+end
+
+group :test do
+  gem 'webmock'  
+  gem 'vcr'  
+  gem 'byebug'
+end
+
+group :development, :test do
+  gem 'awesome_print', require: 'ap'
+end

data/Gemfile.lock

@@ -0,0 +1,104 @@
+PATH
+  remote: .
+  specs:
+    reiformslive-ruby (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.5.1)
+      public_suffix (~> 2.0, >= 2.0.2)
+    awesome_print (1.8.0)
+    byebug (9.0.6)
+    coderay (1.1.1)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.3)
+    faraday (0.13.1)
+      multipart-post (>= 1.2, < 3)
+    ffi (1.9.18)
+    formatador (0.2.5)
+    guard (2.14.1)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (~> 1.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.9.12)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-bundler (2.1.0)
+      bundler (~> 1.0)
+      guard (~> 2.2)
+      guard-compat (~> 1.1)
+    guard-compat (1.2.1)
+    guard-rspec (4.7.3)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
+    hashdiff (0.3.4)
+    json (2.1.0)
+    listen (3.1.5)
+      rb-fsevent (~> 0.9, >= 0.9.4)
+      rb-inotify (~> 0.9, >= 0.9.7)
+      ruby_dep (~> 1.2)
+    lumberjack (1.0.12)
+    method_source (0.8.2)
+    multipart-post (2.0.0)
+    nenv (0.3.0)
+    notiffany (0.1.1)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    pry (0.10.4)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    public_suffix (2.0.5)
+    rake (10.5.0)
+    rb-fsevent (0.10.2)
+    rb-inotify (0.9.10)
+      ffi (>= 0.5.0, < 2)
+    rspec (3.6.0)
+      rspec-core (~> 3.6.0)
+      rspec-expectations (~> 3.6.0)
+      rspec-mocks (~> 3.6.0)
+    rspec-core (3.6.0)
+      rspec-support (~> 3.6.0)
+    rspec-expectations (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-mocks (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-support (3.6.0)
+    ruby_dep (1.5.0)
+    safe_yaml (1.0.4)
+    shellany (0.0.1)
+    slop (3.6.0)
+    thor (0.19.4)
+    vcr (3.0.3)
+    webmock (3.0.1)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  awesome_print
+  bundler (~> 1.13)
+  byebug
+  faraday (~> 0.13.1)
+  guard
+  guard-bundler
+  guard-rspec
+  json (~> 2.1.0)
+  rake (~> 10.0)
+  reiformslive-ruby!
+  rspec (~> 3.0)
+  vcr
+  webmock
+
+BUNDLED WITH
+   1.13.7

data/Guardfile

@@ -0,0 +1,82 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec features) \
+#  .select{|d| Dir.exists?(d) ? d : UI.warning("Directory #{d} does not exist")}
+
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separately)
+#  * 'just' rspec: 'rspec'
+
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # Feel free to open issues for suggestions and improvements
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+
+  # Rails files
+  rails = dsl.rails(view_extensions: %w(erb haml slim))
+  dsl.watch_spec_files_for(rails.app_files)
+  dsl.watch_spec_files_for(rails.views)
+
+  watch(rails.controllers) do |m|
+    [
+      rspec.spec.call("routing/#{m[1]}_routing"),
+      rspec.spec.call("controllers/#{m[1]}_controller"),
+      rspec.spec.call("acceptance/#{m[1]}")
+    ]
+  end
+
+  # Rails config changes
+  watch(rails.spec_helper)     { rspec.spec_dir }
+  watch(rails.routes)          { "#{rspec.spec_dir}/routing" }
+  watch(rails.app_controller)  { "#{rspec.spec_dir}/controllers" }
+
+  # Capybara features specs
+  watch(rails.view_dirs)     { |m| rspec.spec.call("features/#{m[1]}") }
+  watch(rails.layouts)       { |m| rspec.spec.call("features/#{m[1]}") }
+
+  # Turnip features and steps
+  watch(%r{^spec/acceptance/(.+)\.feature$})
+  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$}) do |m|
+    Dir[File.join("**/#{m[1]}.feature")][0] || "spec/acceptance"
+  end
+end
+
+guard :bundler do
+  require 'guard/bundler'
+  require 'guard/bundler/verify'
+  helper = Guard::Bundler::Verify.new
+
+  files = ['Gemfile']
+  files += Dir['*.gemspec'] if files.any? { |f| helper.uses_gemspec?(f) }
+
+  # Assume files are symlinked from somewhere
+  files.each { |file| watch(helper.real_path(file)) }
+end

data/README.md

@@ -0,0 +1,36 @@
+# Reisa::Wrapper
+
+A ruby wrapper for the REIFormslive developers API.
+
+See REIFormslive [developers documetaion](http://developer.reiformslive.com.au/docs/index.html) for full details on the API. 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'reisa-wrapper'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install reisa-wrapper
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/reisa-wrapper. 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.
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "reisa/wrapper"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/reiformslive/core_ext.rb

@@ -0,0 +1,5 @@
+class String
+  def parse_json
+    JSON.parse(self)
+  end
+end

data/lib/reiformslive/credentials.rb

@@ -0,0 +1,9 @@
+module REIformslive
+  class Credentials
+    attr_reader :username, :password
+    
+    def initialize username: '', password: ''
+      @username, @password = username, password
+    end
+  end
+end

data/lib/reiformslive/form.rb

@@ -0,0 +1,105 @@
+module REIformslive
+  class Form
+    PATH = '/forms'.freeze
+
+    attr_reader :data
+    
+    def initialize data: {}
+      @data = data
+    end
+   
+    def id
+      data['id'].to_i
+    end
+   
+    def template_version_id
+      data['template_version_id'].to_i
+    end
+
+    def agency_id
+      data['agency_id'].to_i
+    end
+
+    def user_id
+      data['user_id'].to_i
+    end
+
+    def name
+      data['name']
+    end
+
+    def template?
+      data['template'].to_s == 'true'
+    end
+
+    def finalised?
+      data['finalised'].to_s == 'true'
+    end
+
+    def private?
+      data['private'].to_s == 'true'
+    end
+
+    def created_at
+      Time.at data['created'].to_i
+    end
+
+    def updated_at
+      Time.at data['updated'].to_i
+    end
+
+    def given_name
+      data['given_name']
+    end
+
+    def surname
+      data['surname']
+    end
+
+    def full_name
+      "#{given_name} #{surname}"
+    end
+
+    def template_cost
+      data['template_cost'].to_i
+    end
+
+    def template_id
+      data['template_id'].to_i
+    end
+
+    def template_name
+      data['template_name']
+    end
+
+    def template_code
+      data['template_code']
+    end
+
+    def template_instruction_pages
+      data['template_instruction_pages'].to_i
+    end
+
+    def update data={}, path: "#{PATH}/#{id}/save"
+      REIformslive::Session
+        .put(path: path, data: data)
+        .parse_json['message']
+        .send(:==, 'The form has been saved.')
+        .tap{|ok| @data = self.class.find(id).data if ok }
+    end
+
+    def self.all path: PATH
+      REIformslive::Session
+        .get(path: path)
+        .parse_json
+        .map{|data| self.new data: data }
+    end
+
+    def self.find id, path: "#{PATH}/#{id}"
+      self.new data:
+        REIformslive::Session
+          .get(path: path)
+          .parse_json
+    end
+  end
+end

data/lib/reiformslive/session.rb

@@ -0,0 +1,27 @@
+module REIformslive
+  class Session
+    require 'faraday'
+
+    def self.get path: '/'
+      connection
+        .get(path)
+        .body
+    end
+
+    def self.put path: '/', data: {}
+      connection
+        .put(path, data)
+        .body
+    end
+
+    def self.base_url
+      'https://sa-api.staging.reiformslive.com.au'
+    end
+
+    def self.connection
+      conn = Faraday.new base_url
+      conn.basic_auth '4b66ff95-ade7-413e-b086-0044de7b4ccf', 'ae7e5a1b-e85d-43c4-8d01-fd5cb47d7044'
+      conn
+    end
+  end
+end

data/lib/reiformslive/template.rb

@@ -0,0 +1,51 @@
+module REIformslive
+  class Template
+    require 'reiformslive/core_ext'
+
+    PATH = '/templates'.freeze
+
+    attr_reader :data, :path
+    
+    def initialize data: '{}'
+      @data = data
+    end
+
+    def cost
+      data['cost'].to_i
+    end
+
+    def active
+      data['active']
+    end
+
+    def id
+      data['id'].to_i
+    end
+
+    def name
+      data['name']
+    end
+
+    def code
+      data['code']
+    end
+
+    def template_group_id
+      data['template_group_id'].to_i
+    end
+
+    def self.all
+      REIformslive::Session
+        .get(path: PATH)
+        .parse_json
+        .map{|data| self.new data: data }
+    end
+
+    def self.find id
+      self.new data:
+        REIformslive::Session
+          .get(path: "#{PATH}/#{id}")
+          .parse_json
+    end
+  end
+end

data/lib/reiformslive/user_template.rb

@@ -0,0 +1,93 @@
+module REIformslive
+  class UserTemplate
+    PATH = '/user-templates'.freeze
+
+    attr_reader :data
+    
+    def initialize data: '{}'
+      @data = data
+    end
+
+    def id
+      data['id'].to_i
+    end
+
+    def template_version_id
+      data['template_version_id'].to_i
+    end
+
+    def agency_id
+      data['agency_id'].to_i
+    end
+
+    def user_id
+      data['user_id'].to_i
+    end
+
+    def name
+      data['name']
+    end
+
+    def template?
+      data['template'].to_s == 'true'
+    end
+
+    def finalised?
+      data['finalised'].to_s == 'true'
+    end
+
+    def private?
+      data['private'].to_s == 'true'
+    end
+
+    def created_at
+      Time.at data['created'].to_i
+    end
+
+    def updated_at
+      Time.at data['updated'].to_i
+    end
+
+    def given_name
+      data['given_name']
+    end
+
+    def surname
+      data['surname']
+    end
+
+    def full_name
+      "#{given_name} #{surname}"
+    end
+
+    def template_cost
+      data['template_cost'].to_i
+    end
+
+    def template_id
+      data['template_id'].to_i
+    end
+
+    def original_template_name
+      data['template_name']
+    end
+
+    def original_template_code
+      data['template_code']
+    end
+
+    def self.all
+      REIformslive::Session
+        .get(path: PATH)
+        .parse_json
+        .map{|data| self.new data: data }
+    end
+
+    def self.find id
+      self.new data:
+        REIformslive::Session
+          .get(path: "#{PATH}/#{id}")
+          .parse_json
+    end
+  end
+end

data/lib/reiformslive/version.rb

@@ -0,0 +1,3 @@
+module REIformslive
+  VERSION = "0.1.0"
+end

data/reiformslive-ruby.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'reiformslive/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "reiformslive-ruby"
+  spec.version       = REIformslive::VERSION
+  spec.authors       = ["David Milanese"]
+  spec.email         = ["milanese.david@gmail.com"]
+
+  spec.summary       = %q{An API wrapper for REISA developers API in ruby}
+  spec.description   = %q{An API wrapper for REISA developers API in ruby}
+  spec.homepage      = "https://github.com/aussiDavid/reiformslive-ruby"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "json", "~> 2.1"
+  spec.add_development_dependency "faraday", "~> 0.13.1"
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: reiformslive-ruby
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- David Milanese
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-08-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.1
+description: An API wrapper for REISA developers API in ruby
+email:
+- milanese.david@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/reiformslive/core_ext.rb
+- lib/reiformslive/credentials.rb
+- lib/reiformslive/form.rb
+- lib/reiformslive/session.rb
+- lib/reiformslive/template.rb
+- lib/reiformslive/user_template.rb
+- lib/reiformslive/version.rb
+- reiformslive-ruby.gemspec
+homepage: https://github.com/aussiDavid/reiformslive-ruby
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.10
+signing_key: 
+specification_version: 4
+summary: An API wrapper for REISA developers API in ruby
+test_files: []