nds_api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4336a2664e431cb4dc5ae26fba7a53175c36c13f9f00517cc7d7941ccb553613
+  data.tar.gz: fba0168eae9939f7e921f0d2d42f25fc11fb4d81d511af0174afdf5b76919bb9
+SHA512:
+  metadata.gz: 2acbe60167c1e1ff434f46cb3f90bfdb8055af22be44731967c64b57e4b34f3ff2943857d2507bc147752139b402a1ca0c97348a9023669ea96cbdd77897fc3d
+  data.tar.gz: 9244b5ddff0a135f29f46986f005d375c5ce1c33cfbcf9d959dc93e2213398c638cae4ebb877b4f27c6f04b792a4abbe958f60cebc7bd782992b5767e8289a1d

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in nds_api.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,20 @@
+PATH
+  remote: .
+  specs:
+    nds_api (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    rake (12.3.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  nds_api!
+  rake (~> 12.0)
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Pierre
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,129 @@
+# NdsApi
+
+NDS API is a Rubygem for easy interface with the NDS API. NDS is the National Data System for Child Care. NDS is a variety of applications and services that facilitate the work of Child Care R&Rs. This Ruby code is an interface to the new NDS API. This code is built and maintained by Exygy, in San Francisco. NDS is built by Child Care Aware of America. For any questions about using this code, please contact hello@exygy.com. For more information about NDS please see https://usa.childcareaware.org/members-providers/data-services/
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'nds_api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install nds_api
+
+## Usage
+
+```ruby
+nds = NdsApi::Client.new(
+    user: 'username',
+    password: '############'
+)
+```
+
+##### CLIENT
+
+
+Create client
+
+```ruby
+nds.create_client(data)
+```
+
+Visit https://developer.uatup.naccrraware.net/#42d4c898-5868-19a8-0704-18235fa44a5e for fields
+
+```ruby
+nds.update_client(data)
+```
+
+```ruby
+nds.clients
+nds.client_by_email(email)      
+nds.client_by_phone(phone)      
+nds.client_by_first_name_and_last_name(first_name, last_name)      
+nds.client_by_id(id)      
+```
+
+##### CHILDREN
+
+```ruby
+
+nds.create_child(data)
+nds.update_child(data)
+
+nds.children      
+nds.child_by_uid(uid)      
+nds.children_by_client_id(client_id)      
+```
+
+##### COMMUNITIES
+
+```ruby
+nds.communities()
+```
+
+##### PERSON
+
+```ruby
+
+nds.create_person(data)
+nds.update_person(data)
+
+nds.persons()
+nds.person_by_id(id)      
+```
+
+#### POSITIONS
+
+```ruby
+nds.positions_by_work_email(email)      
+```
+
+##### PROVIDERS
+
+```ruby
+nds.update_provider(data)
+
+nds.providers()      
+nds.provider_by_uid(uid)      
+nds.provider_by_id(id)      
+nds.providers_by_center_name(center_name)      
+nds.providers_by_email(email)      
+nds.provider_schedule(uid)      
+nds.provider_rates(uid)      
+nds.provider_enrollments(uid)      
+```
+
+##### REFERRALS
+
+```ruby
+nds.create_referral(data)
+
+nds.referrals()      
+nds.referral_by_id(id)      
+nds.referral_by_client_id(id)      
+nds.referrals_before_date(date)      
+nds.referrals_after_date(date)      
+nds.referrals_in_date_range(start_date, end_date)      
+```
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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]/nds_api.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "nds_api"
+
+# 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(__FILE__)

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/nds_api.rb

@@ -0,0 +1,78 @@
+require "nds_api/http"
+require "nds_api/url"
+require "nds_api/version"
+
+module NdsApi
+  class Client
+
+    # Create a new client instance
+    #
+    # @param [Hash] options
+    # @option options [String] :user NDS User
+    # @option options [String] :password NDS Password
+    #
+    # @return [NdsApi::Client] a new client instance
+
+
+    # NdsApi::Client.new({user: 'exygy', password: 'SnowflakeFrog?'}).providers
+
+    def initialize(options = {})
+      @options = options.dup
+      @http = NdsApi::Http.new(options)
+      @url = NdsApi::Url
+    end
+
+    def method_missing(method, *args, &block)
+      @method = method
+      if is_create? or is_update?
+        @args = args
+        @http.post(@url.send(url), data) if is_create?
+        @http.put(@url.send(url), data) if is_update?
+      else
+        @http.get(@url.send(method, *args, &block))
+      end
+    end
+
+    private
+
+    def data
+      @args[:data]
+    end
+
+    def method_split
+      @method_split ||= method.split('_')
+    end
+
+    def is_create?
+      method.include? 'create'
+    end
+
+    def is_update?
+      method.include? 'update'
+    end
+
+    def method
+      @method_str ||= @method.to_s
+    end
+
+    def url
+      method_split ||= @method.split('_')
+      action = method_split[0]
+      object_type =
+        case method_split[1]
+        when 'child'
+          'children'
+        when 'client'
+          'clients'
+        when 'referral'
+          'referrals'
+        when 'person'
+          'persons'
+        when 'provider'
+          'providers'
+        end
+      "#{action}_#{object_type}"
+    end
+
+  end
+end

data/lib/nds_api/http.rb

@@ -0,0 +1,57 @@
+require 'json'
+require 'net/http'
+require 'open-uri'
+require 'uri'
+
+module NdsApi
+  class Http
+    def initialize(options = {})
+      @options = options.dup
+    end
+
+    def get(url)
+      JSON.parse(open(url, http_basic_authentication: [api_user, api_password]).read)
+    rescue => e
+      puts "failed #{e}"
+      return e
+    end
+
+    def post(url, data)
+      http_action('post', url, data)
+    end
+
+    def put(url, data)
+      http_action('put', url, data)
+    end
+
+    private
+
+    def http_action(post_or_put, url, data)
+      url = URI.parse(url)
+      req = http_verb_object(post_or_put).new(
+        url.path,
+        'Content-Type' => 'application/json'
+      )
+      req.basic_auth api_user, api_password
+      req.use_ssl = true
+      req.form_data(data)
+      Net::HTTP.new(url.host, url.port).start{ |http| http.request(req) }
+    rescue => e
+      puts "failed #{e}"
+      return e
+    end
+
+    def http_verb_object(post_or_put)
+      return Net::HTTP::Post if post_or_put == "post"
+      return Net::HTTP::Put if post_or_put == "put"
+    end
+
+    def api_user
+      @options[:user]
+    end
+
+    def api_password
+      @options[:password]
+    end
+  end
+end

data/lib/nds_api/url.rb

@@ -0,0 +1,141 @@
+module NdsApi
+  module Url
+    class << self
+      ##### CLIENTS #####
+
+      def clients
+        "#{base_url}/clients"
+      end
+
+      def client_by_email(email)
+        "#{client_search}/findByEmail?email=#{email}"
+      end
+
+      def client_by_phone(phone)
+        "#{client_search}/findByPhone?phone=#{phone}"
+      end
+
+      def client_by_first_name_and_last_name(first_name, last_name)
+        "#{client_search}/findByName?lastName=#{last_name}&firstName=#{first_name}"
+      end
+
+      def client_by_id(id)
+        "#{clients}/#{id}"
+      end
+
+      ##### CHILDREN #####
+
+      def children
+        "#{base_url}/children"
+      end
+
+      def child_by_uid(uid)
+        "#{children}/#{uid}"
+      end
+
+      def children_by_client_id(client_id)
+        "#{base_url}/clients/#{client_id}/children"
+      end
+
+      ##### COMMUNITIES #####
+
+      def communities
+        "#{base_url}/communities?sort=lastModifiedTime,DESC"
+      end
+
+      ##### PERSON #####
+
+      def persons
+        "#{base_url}/persons"
+      end
+
+      def person_by_id(id)
+        "#{persons}/#{id}"
+      end
+
+      #### POSITIONS #####
+
+      def positions_by_work_email(email)
+        "#{base_url}/positions/search/findByWorkEmail?workEmail=#{email}"
+      end
+
+      ##### PROVIDERS #####
+
+      def providers
+        "#{base_url}/providers"
+      end
+
+      def provider_by_uid(uid)
+        "#{base_url}/providers/#{uid}"
+      end
+
+      def provider_by_id(id)
+        "#{base_url}/providers/search/findByProviderId?providerId=#{id}"
+      end
+
+      def providers_by_center_name(center_name)
+        "#{provider_search}/findByCenterName?centerName=#{center_name}"
+      end
+
+      def providers_by_email(email)
+        "#{provider_search}/findByEmail?email=#{email}"
+      end
+
+      def provider_schedule(uid)
+        "#{providers}/#{uid}/schedule"
+      end
+
+      def provider_rates(uid)
+        "#{providers}/#{uid}/rates"
+      end
+
+      def provider_enrollments(uid)
+        "#{providers}/#{uid}/enrollments"
+      end
+
+      ##### REFERRALS #####
+
+      def referrals
+        "#{base_url}/referrals"
+      end
+
+      def referral_by_id(id)
+        "#{referrals}/#{id}"
+      end
+
+      def referral_by_client_id(id)
+        "#{clients}/#{id}/referrals"
+      end
+
+      def referrals_before_date(date)
+        "#{referral_search}/findByDateBefore?date=#{date}"
+      end
+
+      def referrals_after_date(date)
+        "#{referral_search}/findByDateAfter?date=#{date}"
+      end
+
+      def referrals_in_date_range(start_date, end_date)
+        "#{referral_search}/findByDateBetween?startDate=#{start_date}&endDate=#{end_date}"
+      end
+
+      private
+
+      def client_search
+        "#{clients}/search"
+      end
+
+      def provider_search
+        "#{providers}/search"
+      end
+
+      def referral_search
+        "#{referrals}/search"
+      end
+
+      def base_url
+        'https://uatup.naccrraware.net/nds-api'
+      end
+    end
+  end
+end

data/lib/nds_api/version.rb

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

data/nds_api.gemspec

@@ -0,0 +1,26 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "nds_api/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "nds_api"
+  spec.version       = NdsApi::VERSION
+  spec.authors       = ["Pierre Hunault"]
+  spec.email         = ["pierre@exygy.com"]
+
+  spec.summary       = %q{Connect to NDS API and retrieve records.}
+  spec.description   = %q{Connect to NDS API and retrieve records.}
+  spec.homepage      = "http://exygy.com"
+  spec.license       = "MIT"
+
+  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.16"
+  spec.add_development_dependency "rake", "~> 12.0"
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: nds_api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Pierre Hunault
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-04-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+description: Connect to NDS API and retrieve records.
+email:
+- pierre@exygy.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/nds_api.rb
+- lib/nds_api/http.rb
+- lib/nds_api/url.rb
+- lib/nds_api/version.rb
+- nds_api.gemspec
+homepage: http://exygy.com
+licenses:
+- MIT
+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.7.6
+signing_key: 
+specification_version: 4
+summary: Connect to NDS API and retrieve records.
+test_files: []