nlbsg 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c50e7142ddcb0174c13b1f6fccc7798ec78499e27851efcc8f5b05df8939deb8
+  data.tar.gz: 29c8ba38f8be2f6c205a93f5be61f69c22a18c71d4f1c90f5ad211227b669003
+SHA512:
+  metadata.gz: ac78b017f35de63f5364113bc9c34a685eabcd8f6351d1a74da10c7919713b07c8e22e7d4ba38a62b8df9249d567295cdf17af898c694a17c4a2c9a3a82752df
+  data.tar.gz: 3a78a09514b55ac1f9fe1a4b2ca79f481ee75031d572eeac9f5e5910d888a4fd7b0a7023b2b6a811b69e8c9e5f16df14049d6d893185fb6de2862d665541ad3b

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"
+
+# Specify your gem's dependencies in nlbsg.gemspec
+gemspec
+
+gem "rake", "~> 12.0"

data/Gemfile.lock

@@ -0,0 +1,52 @@
+PATH
+  remote: .
+  specs:
+    nlbsg (0.1.0)
+      savon (~> 2.12.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    akami (1.3.1)
+      gyoku (>= 0.4.0)
+      nokogiri
+    builder (3.2.4)
+    gyoku (1.3.1)
+      builder (>= 2.1.2)
+    httpi (2.4.5)
+      rack
+      socksify
+    mini_portile2 (2.5.3)
+    nokogiri (1.11.7)
+      mini_portile2 (~> 2.5.0)
+      racc (~> 1.4)
+    nori (2.6.0)
+    public_suffix (4.0.6)
+    racc (1.5.2)
+    rack (2.2.3)
+    rake (12.3.3)
+    savon (2.12.1)
+      akami (~> 1.2)
+      builder (>= 2.1.2)
+      gyoku (~> 1.2)
+      httpi (~> 2.3)
+      nokogiri (>= 1.8.1)
+      nori (~> 2.4)
+      wasabi (~> 3.4)
+    socksify (1.7.1)
+    wasabi (3.6.1)
+      addressable
+      httpi (~> 2.0)
+      nokogiri (>= 1.4.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  nlbsg!
+  rake (~> 12.0)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Chethan Anil
+
+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,40 @@
+# NLBSG
+
+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/nlbsg`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'nlbsg'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install nlbsg
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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/pest-control/nlbsg.
+
+
+## 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 "nlbsg"
+
+# 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/nlbsg.rb

@@ -0,0 +1,25 @@
+require "nlbsg/constants"
+require "nlbsg/client"
+require "nlbsg/exceptions"
+require "nlbsg/version"
+require "nlbsg/request"
+require "nlbsg/response"
+
+require 'savon'
+
+module NLBSG
+  def self.client(key:, env: :staging)
+    @key = key
+    @env = env
+
+    return Client.new
+  end
+
+  def self.key
+    @key
+  end
+
+  def self.env
+    @env
+  end
+end

data/lib/nlbsg/client.rb

@@ -0,0 +1,54 @@
+module NLBSG
+  class Client
+
+    DEFAULT_CONFIG =
+      {
+        convert_request_keys_to: :camelcase,
+        open_timeout: 300,
+        read_timeout: 300
+      }
+
+    def search(options)
+      request = SearchRequest.new(options).build
+      response = client.call(:search, message: request)
+      SearchResponse.new(response)
+    end
+
+    def get_title_details(options)
+      request = GetTitleDetailsRequest.new(options).build
+      response = client.call(:get_title_details, message: request)
+      GetTitleDetailsResponse.new(response)
+    end
+
+    def get_availability_info(options)
+      request = GetAvailabilityInfoRequest.new(options).build
+      response = client.call(:get_availability_info, message: request)
+      GetAvailabilityInfoResponse.new(response)
+    end
+
+    def operations
+      client.operations
+    end
+
+    alias_method :title, :get_title_details
+    alias_method :availability, :get_availability_info
+
+    private
+
+      def client
+        @client ||= Savon.client(config)
+      end
+
+      def config
+        DEFAULT_CONFIG.merge(wsdl: wsdl)
+      end
+
+      def wsdl
+        if NLBSG.env == :production
+          NLBSG::WSDL[:production]
+        elsif NLBSG.env == :staging
+          NLBSG::WSDL[:staging]
+        end
+      end
+  end
+end

data/lib/nlbsg/constants.rb

@@ -0,0 +1,62 @@
+module NLBSG
+  WSDL =
+    {
+      staging: "https://openweb-stg.nlb.gov.sg/OWS/CatalogueService.svc?singleWsdl",
+      production: "https://openweb.nlb.gov.sg/OWS/CatalogueService.svc?singleWsdl"
+    }
+  LANGUAGE =
+    {
+    }
+  MEDIA_CODE =
+    {
+      books: "BK",
+      computer_file: "CF",
+      maps: "MP",
+      music: "MU",
+      mixed_materials: "MX",
+      serials: "SE",
+      visual_materials: "VM"
+    }
+  BRANCH =
+    {
+      "Tampines Regional Library": "TRL",
+      "Woodlands Regional Library": "WRL",
+      "Clementi Public Library": "CMPL",
+      "Lee Kong Chian Reference Library": "LKCRL",
+      "Ang Mo Kio Public Library": "AMKPL",
+      "Bukit Batok Public Library": "BBPL",
+      "Bukit Panjang Public Library": "BPPL",
+      "Bukit Merah Public Library": "BMPL",
+      "Central Public Library": "CLL",
+      "Cheng San Public Library": "CSPL",
+      "Choa Chu Kang Public Library": "CCKPL",
+      "Geylang East Public Library": "GEPL",
+      "Jurong Regional Library": "JRL",
+      "Jurong West Public Library": "JWPL",
+      "Queenstown Public Library": "QUPL",
+      "Toa Payoh Public Library": "TPPL",
+      "Yishun Public Library": "YIPL",
+      "Library@Orchard": "OCPL",
+      "Library@Chinatown": "CNPL",
+      "Sembawang Public Library": "SBPL",
+      "Library Supply Centre": "LSC",
+      "Serangoon Public Library": "SRPL",
+      "NL Heritage": "LOLC",
+      "Marine Parade Public Library": "MPPL",
+      "Bedok Public Library": "BEPL",
+      "Sengkang Public Library": "SKPL",
+      "Library@Esplanade": "EPPL",
+      "Mobile Bus": "MOLLEY",
+      "Pasir Ris Public Library": "PRPL",
+      "Bishan Public Library": "BIPL",
+      "Library Supply Centre for AV": "LSCAV",
+      "Lee Kong Chian Reference Library Level 7": "07LKCRL",
+      "Lee Kong Chian Reference Library Level 8": "08LKCRL",
+      "Lee Kong Chian Reference Library Level 9": "09LKCRL",
+      "Lee Kong Chian Reference Library Level 11": "11LKCRL",
+      "HarbourFront Public Library": "HBPL"
+    }
+  STATUS_CODE =
+    {
+    }
+end

data/lib/nlbsg/request.rb

@@ -0,0 +1,14 @@
+module NLBSG
+  class RequestBase
+
+    attr_accessor :options
+
+    def build(options)
+      options.merge(API_key: NLBSG.key)
+    end
+  end
+end
+
+require_relative "request/search"
+require_relative "request/get_title_details"
+require_relative "request/get_availability_info"

data/lib/nlbsg/request/get_availability_info.rb

@@ -0,0 +1,59 @@
+module NLBSG
+  class GetAvailabilityInfoRequest < RequestBase
+    REQUIRED_REQUEST_FIELDS =
+      [
+        :BID,
+        :ISBN
+      ]
+
+    MODIFIERS =
+      [
+        :sort_schema,
+        :start_record_position,
+        :maximum_records,
+        :set_id
+      ]
+
+    def initialize(hash)
+      raise ArgumentError unless hash.is_a?(Hash)
+
+      @options = hash
+    end
+
+    def build
+      query = prepare_query.merge(modifiers: prepare_modifiers)
+
+      super(query)
+    end
+
+    private
+
+      def prepare_modifiers
+        keys = options.keys & MODIFIERS
+
+        modifiers = {}
+
+        keys.each do |key|
+          modifiers[key] = options[key]
+        end
+
+        modifiers
+      end
+
+      def prepare_query
+        if (options.keys & REQUIRED_REQUEST_FIELDS).empty?
+          raise ArgumentError
+        end
+
+        keys = options.keys & REQUIRED_REQUEST_FIELDS
+
+        query = {}
+
+        keys.each do |key|
+          query[key] = options[key]
+        end
+
+        query
+      end
+  end
+end

data/lib/nlbsg/request/get_title_details.rb

@@ -0,0 +1,37 @@
+module NLBSG
+  class GetTitleDetailsRequest < RequestBase
+    REQUIRED_REQUEST_FIELDS =
+      [
+        :BID,
+        :ISBN
+      ]
+
+    def initialize(hash)
+      raise ArgumentError unless hash.is_a?(Hash)
+
+      @options = hash
+    end
+
+    def build
+      super(prepare_query)
+    end
+
+    private
+
+      def prepare_query
+        if (options.keys & REQUIRED_REQUEST_FIELDS).empty?
+          raise ArgumentError
+        end
+
+        keys = options.keys & REQUIRED_REQUEST_FIELDS
+
+        query = {}
+
+        keys.each do |key|
+          query[key] = options[key]
+        end
+
+        query
+      end
+  end
+end

data/lib/nlbsg/request/search.rb

@@ -0,0 +1,93 @@
+module NLBSG
+  class SearchRequest < RequestBase
+    REQUIRED_SEARCH_FIELDS =
+      [
+        :keywords,
+        :author,
+        :subject,
+        :title
+      ]
+
+    OPTIONAL_SEARCH_FIELDS =
+      [
+        :branch_ID,
+        :media_code,
+        :language
+      ]
+
+    ALL_SEARCH_FIELDS = REQUIRED_SEARCH_FIELDS + OPTIONAL_SEARCH_FIELDS
+
+    MODIFIERS =
+      [
+        :sort_schema,
+        :start_record_position,
+        :maximum_records,
+        :set_id
+      ]
+
+    def initialize(string_or_hash)
+      if string_or_hash.is_a?(String)
+        @options = { keywords: string_or_hash }
+      elsif string_or_hash.is_a?(Hash)
+        @options = string_or_hash
+      else
+        raise ArgumentError
+      end
+    end
+
+    def build
+      search_items = prepare_search_items
+      modifiers = prepare_modifiers
+      query = prepare_query(search_items, modifiers)
+
+      super(query)
+    end
+
+    private
+
+      def prepare_search_items
+        if (options.keys & REQUIRED_SEARCH_FIELDS).empty?
+          raise ArgumentError
+        end
+
+        keys = options.keys & ALL_SEARCH_FIELDS
+
+        search_items = []
+
+        keys.each do |key|
+          search_items << add_search_item(field: key, terms: options[key])
+        end
+
+        search_items
+      end
+
+      def prepare_modifiers
+        keys = options.keys & MODIFIERS
+
+        modifiers = {}
+
+        keys.each do |key|
+          modifiers[key] = options[key]
+        end
+
+        modifiers
+      end
+
+      def prepare_query(search_items, modifiers)
+        {
+          search_items:
+            {
+              search_item: search_items
+            },
+          modifiers: modifiers
+        }
+      end
+
+      def add_search_item(field:, terms:)
+        {
+          search_field: field.to_s.split('_').collect(&:capitalize).join,
+          search_terms: terms
+        }
+      end
+  end
+end

data/lib/nlbsg/response.rb

@@ -0,0 +1,38 @@
+module NLBSG
+  class ResponseBase
+
+    attr_accessor :response
+
+    def initialize(response)
+      @response = response
+    end
+
+    def status
+      response[:status]
+    end
+
+    def message
+      response[:message]
+    end
+
+    def error_message
+      response[:error_message]
+    end
+
+    private
+
+      def wrap_in_array(object)
+        if object.nil?
+          []
+        elsif object.is_a?(Array)
+          object
+        else
+          [object]
+        end
+      end
+  end
+end
+
+require_relative "response/search"
+require_relative "response/get_title_details"
+require_relative "response/get_availability_info"

data/lib/nlbsg/response/get_availability_info.rb

@@ -0,0 +1,24 @@
+module NLBSG
+  class GetAvailabilityInfoResponse < ResponseBase
+
+    def initialize(response)
+      super(response.to_hash[:get_availability_info_response])
+    end
+
+    def next_record_position
+      @response[:next_record_position]
+    end
+
+    def set_id
+      @response[:set_id]
+    end
+
+    def items
+      wrap_in_array(@response.dig(:items, :item))
+    end
+
+    def fetch_next_records
+      p "TODO"
+    end
+  end
+end

data/lib/nlbsg/response/get_title_details.rb

@@ -0,0 +1,68 @@
+module NLBSG
+  class GetTitleDetailsResponse < ResponseBase
+
+    def initialize(response)
+      super(response.to_hash[:get_title_details_response])
+    end
+
+    def title_detail
+      response[:title_detail]
+    end
+
+    def bid
+      title_detail[:bid]
+    end
+
+    def title_name
+      title_detail[:title_name]
+    end
+
+    def author
+      title_detail[:author]
+    end
+
+    def other_authors
+      title_detail[:other_authors]
+    end
+
+    def publisher
+      title_detail[:publisher]
+    end
+
+    def physical_desc
+      title_detail[:physical_desc]
+    end
+
+    def subject
+      title_detail[:subject]
+    end
+
+    def summary
+      title_detail[:summary]
+    end
+
+    def notes
+      title_detail[:notes]
+    end
+
+    def isbn
+      title_detail[:isbn]
+    end
+
+    def issn
+      title_detail[:issn]
+    end
+
+    def n_title_name
+      title_detail[:n_title_name]
+    end
+
+    def n_author_name
+      title_detail[:n_author_name]
+    end
+
+    def n_publisher
+      title_detail[:n_publisher]
+    end
+  end
+end

data/lib/nlbsg/response/search.rb

@@ -0,0 +1,28 @@
+module NLBSG
+  class SearchResponse < ResponseBase
+
+    def initialize(response)
+      super(response.to_hash[:search_response])
+    end
+
+    def total_records
+      @response[:total_records]
+    end
+
+    def next_record_position
+      @response[:next_record_position]
+    end
+
+    def set_id
+      @response[:set_id]
+    end
+
+    def titles
+      wrap_in_array(@response.dig(:titles, :title))
+    end
+
+    def fetch_next_records
+      p "TODO"
+    end
+  end
+end

data/lib/nlbsg/version.rb

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

data/nlbsg.gemspec

@@ -0,0 +1,27 @@
+require_relative 'lib/nlbsg/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "nlbsg"
+  spec.version       = NLBSG::VERSION
+  spec.authors       = ["Chethan Anil"]
+  spec.email         = ["chethan@anil.sg"]
+
+  spec.summary       = %q{A ruby wrapper for the NLB SG API}
+  spec.homepage      = "https://github.com/pest-control/nlbsg"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/pest-control/nlbsg"
+  spec.metadata["changelog_uri"] = "https://github.com/pest-control/nlbsg"
+
+  # 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(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |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_dependency "savon", "~> 2.12.0"
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: nlbsg
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Chethan Anil
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-06-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: savon
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.12.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.12.0
+description:
+email:
+- chethan@anil.sg
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/nlbsg.rb
+- lib/nlbsg/client.rb
+- lib/nlbsg/constants.rb
+- lib/nlbsg/exceptions.rb
+- lib/nlbsg/request.rb
+- lib/nlbsg/request/get_availability_info.rb
+- lib/nlbsg/request/get_title_details.rb
+- lib/nlbsg/request/search.rb
+- lib/nlbsg/response.rb
+- lib/nlbsg/response/get_availability_info.rb
+- lib/nlbsg/response/get_title_details.rb
+- lib/nlbsg/response/search.rb
+- lib/nlbsg/version.rb
+- nlbsg.gemspec
+homepage: https://github.com/pest-control/nlbsg
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/pest-control/nlbsg
+  source_code_uri: https://github.com/pest-control/nlbsg
+  changelog_uri: https://github.com/pest-control/nlbsg
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key:
+specification_version: 4
+summary: A ruby wrapper for the NLB SG API
+test_files: []