gias 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 56a60c305e47e9ce483de28e2adff99f2be17b3ff29f6492ef2a6a2a128b094f
+  data.tar.gz: ddc996e48c7f70279d1756f64f394dfee9c16ff2bf7ef4cc8a6ced0f0ec0a837
+SHA512:
+  metadata.gz: 97764ba8f3aae8f94b288303f98a7a8196abaa69814ac032f5da9cb035f99b261f13fcb50ce04764eafef222f04e4737be9dc51b6e6303277459672895a19bc2
+  data.tar.gz: 8ead345d18001cede065a2f7f7a0ccfe947fb63ee5707765a14fa505c7ca1c5593dd4fcbaa5b0f532f4cd534bf0f4fc8e44119ec95bd503ab53bae8adf0007cb

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 2.6
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Daniel Dye
+
+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,43 @@
+# Get-Information-About-Schools (GIAS) Ruby Gem
+
+This gem provides a Ruby interface to the Department for Education's Get Information About Schools (GIAS) CSV.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "gias"
+```
+
+## Usage
+
+To get the list of all schools:
+
+```ruby
+Gias::School.all
+```
+
+This will:
+
+- Download the latest CSV from the DfE's website.
+- Convert the CSV to an array of `Gias::School` objects.
+
+The attribute names are the CSV column names, without parentheses, converted to snake_case.
+
+For example:
+
+```ruby
+{
+  "LA (code)" => :la_code,
+  "PhaseOfEducation (name)" => :phase_of_education_name,
+}
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/Nitemaeric/gias.
+
+## 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,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/gias.gemspec

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require_relative "lib/gias/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "gias"
+  spec.version = Gias::VERSION
+  spec.authors = ["Daniel Dye"]
+  spec.email = ["dnitemaeric@gmail.com"]
+
+  spec.summary = "A Ruby gem that provides an interface to the Get Information About Schools (GIAS) CSV data."
+  spec.description = "A Ruby gem that provides an interface to the Get Information About Schools (GIAS) CSV data."
+  # spec.homepage = "TODO: Put your gem's website or public repo URL here."
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to your gem server 'https://example.com'"
+
+  # spec.metadata["homepage_uri"] = spec.homepage
+  # spec.metadata["source_code_uri"] = "TODO: Put your gem's public repo URL here."
+  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) ||
+        f.start_with?(*%w[bin/ test/ spec/ features/ .git .github appveyor Gemfile])
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  spec.add_dependency "activesupport", "~> 7.1.3.2"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/lib/gias/school.rb

@@ -0,0 +1,65 @@
+require "open-uri"
+require "csv"
+require "active_support/all"
+
+module Gias
+  class School
+    HOST = "https://ea-edubase-api-prod.azurewebsites.net"
+
+    attr_reader :attributes
+
+    def initialize(attributes = {})
+      @attributes = attributes
+    end
+
+    def inspect
+      "#<#{self.class.name} #{attributes.map { |k, v| "#{k}: #{v.inspect}"}.join(", ")}>"
+    end
+
+    def method_missing(method_name, *args, &block)
+      if attribute_names.include?(method_name.to_s)
+        @attributes[method_name.to_s]
+      else
+        super
+      end
+    end
+
+    def respond_to_missing?(method_name, include_private = false)
+      attribute_names.include?(method_name.to_s) || super
+    end
+
+    def attribute_names
+      self.class.attribute_names
+    end
+
+    class << self
+      delegate :first, :last, :size, :count, :length, to: :all
+
+      def all
+        @all ||= csv.map do |row|
+          new(row.to_h.transform_keys { convert_header(_1) })
+        end
+      end
+
+      def csv
+        @csv ||= CSV.parse(csv_data, headers: true, empty_value: nil)
+      end
+
+      def csv_data
+        hash = Hash.new do |h, k|
+          h[k] = URI.open(HOST + "/edubase/downloads/public/edubasealldata#{k}.csv")
+        end
+
+        hash[Date.current.strftime("%Y%m%d")]
+      end
+
+      def attribute_names
+        @headers ||= csv.headers.map { convert_header(_1) }
+      end
+
+      def convert_header(header)
+        header.gsub("(", "").gsub(")", "").gsub(" ", "_").underscore
+      end
+    end
+  end
+end

data/lib/gias/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Gias
+  VERSION = "0.1.0"
+end

data/lib/gias.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require_relative "gias/version"
+require_relative "gias/school"
+
+module Gias
+  class Error < StandardError; end
+end

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification
+name: gias
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Daniel Dye
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-04-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 7.1.3.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 7.1.3.2
+description: A Ruby gem that provides an interface to the Get Information About Schools
+  (GIAS) CSV data.
+email:
+- dnitemaeric@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- LICENSE.txt
+- README.md
+- Rakefile
+- gias.gemspec
+- lib/gias.rb
+- lib/gias/school.rb
+- lib/gias/version.rb
+homepage:
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: A Ruby gem that provides an interface to the Get Information About Schools
+  (GIAS) CSV data.
+test_files: []