arduino-library 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2d37473a87d3b6d1db40f35624c2c797529da16c
+  data.tar.gz: 3c8df8283d9c010ef9602ce81e93d892bb7bfcac
+SHA512:
+  metadata.gz: 2c2f9b036d4cd3bd906456ec6fcb1282545eedfc93d4de06ad49938cc2f5d78e6f6b07aad1b769d1e7575ad13a9b370a7e85dad46d1ae8b1561ac0e5c033fa56
+  data.tar.gz: 46a370bc44c4e21a15a12d90ddbd6c50e6104843a65b68b7d79d9810576347aee88540dc0824e0856724540b29fffbff6f5bff49f211fb873f6e0b704dadc35c

data/.gitignore

@@ -0,0 +1,16 @@
+.idea/
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/doc/
+/pkg/
+/coverage/
+/spec/coverage/
+/tmp/
+/data
+/spec/coverage/
+/*.enc
+**/.DS_Store
+.ruby-version
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format progress
+--color
+--order random

data/.travis.yml

@@ -0,0 +1,19 @@
+sudo: false
+env:
+  global:
+    - CI=TRAVIS
+    - CC_TEST_REPORTER_ID=0e339f5c9d1bbcceab27065342b2e22535bb469bd083a6f44ddb8a262f71f8a4
+language: ruby
+rvm:
+  - 2.4.2
+  - 2.3.5
+before_install:
+  - gem install bundler -v 1.15.4
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
+script:
+  - bundle exec rspec --format documentation
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Konstantin Gredeskoul
+
+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,233 @@
+[![Gem Version](https://badge.fury.io/rb/arduino-library.svg)](https://badge.fury.io/rb/arduino-library)
+[![Build Status](https://travis-ci.org/kigster/arduino-library.svg?branch=master)](https://travis-ci.org/kigster/arduino-library)
+[![Maintainability](https://api.codeclimate.com/v1/badges/0da01eba1b556826a231/maintainability)](https://codeclimate.com/github/kigster/arduino-library/maintainability)
+[![Downloads](http://ruby-gem-downloads-badge.herokuapp.com/arduino-library?type=total)](https://rubygems.org/gems/arduino-library)
+
+[![Test Coverage](https://api.codeclimate.com/v1/badges/0da01eba1b556826a231/test_coverage)](https://codeclimate.com/github/kigster/arduino-library/test_coverage)
+[![Test Coverage](https://codeclimate.com/github/kigster/arduino-library/badges/coverage.svg)](https://codeclimate.com/github/kigster/arduino-library/coverage)
+
+# Arduino::Library
+
+This gem encapsulates various rules about the [`library.properties`](https://github.com/arduino/Arduino/wiki/Arduino-IDE-1.5:-Library-specification#library-metadata) file that contains meta-data about Arduino Libraries.
+
+It also provides convenient shortcuts for downloading the Arduino-maintained database of published libraries in JSON format, searching for various libraries, choosing a version, and more.
+
+It also provides validation functionality for the `library.properties` file for your custom libraries you would like to open source.
+ 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'arduino-library'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install arduino-library
+
+## Usage
+
+Current version only contains Ruby-based API and is meant to be consumed by other projects (in particularly, check out [Arli](https://github.com/kigster/arli) — a command-line tool and an Arduino Library Manager and installer). This project is invaluable if you are you using, for example, [arduino-cmake](https://github.com/arduino-cmake/arduino-cmake) project to build and upload your Arduino Code.
+
+
+### Using the top-level module
+
+If you prefer not to have hard-coded dependencies on the `Arduino::Library::*` sub-classes and sub-modules, you can use the top level module, which proxies several shortcut methods.
+
+You can access these methods in two different ways:
+
+  1. As class methods on `Arduino::Library`, for example `Arduino::Library.db_default`
+  2. By including the top-level module in your context, and using methods as instance methods in the current context, eg. `#db_default`
+
+Below we'll focus on the second usage, but if you prefer to use the first syntax, it's there and available for you.
+
+```ruby
+require 'arduino/library'
+include Arduino::Library
+```
+
+#### Using `db_from`
+
+This method returns an instance of the `Arduino::Library::Database` from the provided source:
+
+```ruby
+db_from('library_index.json').size 
+# => 16
+db_from('library_index.json.gz').size
+# => 16
+db_from('http://downloads.arduino.cc/libraries/library_index.json.gz').size 
+# => 3653
+# This required downloading a 400K gzipped file into a temp file, and reading from there.
+```
+
+#### Using `db_default`
+
+This method downloads and returns the official Arduino-maintained index of Arduino libraries.
+
+```ruby
+db_default.size
+# => 3653
+```
+
+#### Using `library_from`
+
+This method reads from a source that can be of many formats (see below) and returns an instantiated `Arduino::Library::Model` for this library. You can then get all library attributes via corresponding methods:
+
+```ruby
+library_from('spec/fixtures/audio_zero.json').name 
+# => 'AudioZero'
+library_from('~/Documents/Arduino/Libraries/AudioZero/library.properties').name 
+#=> 'AudioZero'
+library_from('https://raw.githubusercontent.com/PaulStoffregen/DS1307RTC/master/library.properties').name
+#=> 'DS1307RTC'
+```
+
+#### Using `find`
+
+Method `find` is, perhaps, some of the most powerful functionality in this gem. It allows constructing very flexible and precise queries, to match any number of library attributes.
+
+The method has the following signature:
+
+```ruby
+find(database = db_default, **opts)
+```
+
+`opts` is a Hash that you can use to pass attributes with matchers. All matching results are returned as an array of models.
+
+**Examples**
+
+```ruby
+results = find(
+  name: 'AudioZero',
+  author: /konstantin/i,              # regexp supported
+  architectures: [ 'avr' ],           # array is matched if it's a subset
+  version: proc do |value|            # or a proc for max flexibility
+    value.start_with?('1.')
+  end
+)
+
+results.size 
+#=> <whatever number of matches returned>
+```
+
+Note that multiple attributes must ALL match for the library to be included in the result set.
+
+### `Arduino::Library::Database`
+
+> Downloading the index of all libraries, and finding a library.
+
+You can load libraries from a local JSON file, or from a remote URL, eg:  
+
+```ruby 
+require 'arduino/library'
+
+database = Arduino::Library::Database.from(
+  'http://downloads.arduino.cc/libraries/library_index.json.gz')
+```
+
+or, since the above link happens to be the default location of Arduino-maintained librarie index file, you can use the `default` method instead:
+
+```ruby
+database = Arduino::Library::Database.default
+```
+
+or, load the list from a local JSON file, that can be optionally gzipped (just like the URL):
+
+```ruby
+database = Arduino::Library::Database.from('library_index.json.gz')
+```
+
+Once the library is initialized, the following operations are supported:
+
+```ruby
+database.find(name: 'AudioZero', version: '1.0.1') do |audio_zero|
+  audio_zero.website        #=> http://arduino.cc/en/Reference/Audio
+  audio_zero.architectures  #=> [ 'samd' ] 
+end
+```
+
+You can pass any of the attributes to #find, and the value can be a `String` (in which case only equality matches), or a regular expression, eg:
+
+```ruby
+database.find(author: "Paul Stoffregen").size #=> 21
+database.find(author: /stoffregen/i).size     #=> 33
+```
+
+You interate over multiple using either a block:
+
+```ruby
+database.find(name: 'AudioZero') do |match|
+  puts match.name # => 'AudioZero'
+  puts match.version # => will print all versions of the library available
+end
+```
+
+or, just grab the return value from `#find`, which is always an array.
+
+```ruby
+all_versions = database.find(name: 'AudioZero')
+# => [ Arduino::Library::Model<name: AudioZero, version: '1.0.1',... >, .. ]
+```
+
+### `Arduino::Library::Model` 
+
+> Use this class to operate on a single library.
+
+#### Reading Library from an External Source using `.from`
+
+You can use an intelligent class method `.from` that attempts to auto-detect the type of file or URL you are passing as an argument, and use an appropriate parser for each type. 
+
+For example, to read from a JSON file: 
+
+```ruby
+json_file = 'spec/fixtures/audio_zero.json'
+model = Arduino::Library::Model.from(json_file)
+model.name #=> 'AudioZero'
+```
+
+Or to read from the `.properties` file:
+
+```ruby
+properties_file = 'spec/fixtures/audio_zero.properties'
+model = Arduino::Library::Model.from(properties_file)
+model.name #=> 'AudioZero'
+```
+
+### Presenters
+
+Presenters are there to convert to and from a particular format.
+
+#### `.properties` Presenter
+
+```ruby
+props = Arduino::Library::Presenters::Properties.new(model).present
+File.open('/tmp/audio_zero.properties', 'w') do |f|
+   f.write(props)
+end
+
+# this creates a file in the format:
+
+# name=AudioZero
+# version=1.0.1
+# etc.
+```
+
+## 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/kigster/arduino-library](https://github.com/kigster/arduino-library).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

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

data/arduino-library.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'arduino/library/version'
+
+Gem::Specification.new do |spec|
+  spec.name        = 'arduino-library'
+  spec.version     = Arduino::Library::VERSION
+  spec.authors     = ['Konstantin Gredeskoul']
+  spec.email       = ['kigster@gmail.com']
+  spec.summary     = Arduino::Library::DESCRIPTION
+  spec.description = Arduino::Library::DESCRIPTION
+  spec.homepage    = 'https://github.com/kigster/arduino-library'
+  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_dependency 'dry-configurable'
+  spec.add_dependency 'dry-types'
+  spec.add_dependency 'dry-struct'
+
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'bundler', '~> 1.15'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rspec-its'
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "arduino/library"
+
+# 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/arduino/library.rb

@@ -0,0 +1,55 @@
+require 'open-uri'
+
+module Arduino
+  module Library
+    DEFAULT_ARDUINO_LIBRARY_INDEX_URL = 'http://downloads.arduino.cc/libraries/library_index.json.gz'
+  end
+end
+
+require 'arduino/library/version'
+require 'arduino/library/utilities'
+require 'arduino/library/types'
+# noinspection RubyResolve
+require 'arduino/library/model'
+require 'arduino/library/database'
+
+module Arduino
+  module Library
+    # @param [String] file_or_url — either a local file, or URL, can be gzipped
+    def db_from(file_or_url)
+      Database.new(file_or_url)
+    end
+
+    def db_default
+      Database.default
+    end
+
+    #
+    # +file_or_url+ can be a JSON file name, a .properties file name, or
+    # a URL to either of the above.
+    #
+    # @param [String] file_or_url
+    def library_from(file_or_url)
+      Arduino::Library::Model.from(file_or_url)
+    end
+
+    # +opts+ is a Hash that you can use to pass attributes with values, any
+    # number of them. All matching results are returned as models.
+    #
+    #   name: 'AudioZero'
+    #   author: /konstantin/i              - regexp supported
+    #   architectures: [ 'avr' ]           - array is matched if it's a subset
+    #   version: proc do |value|           — or a proc for max flexibility
+    #     value.start_with?('1.') )
+    #   end
+    #
+    # @param [Hash] opts — hash of attribute names and values to match
+    def find(database = db_default, **opts)
+      Arduino::Library::Model.database = database
+      Arduino::Library::Model.from(nil, **opts)
+    end
+  end
+end
+
+Arduino::Library.extend(Arduino::Library)
+

data/lib/arduino/library/database.rb

@@ -0,0 +1,82 @@
+require 'open-uri'
+require 'zlib'
+require 'json'
+require 'forwardable'
+require 'arduino/library'
+require 'arduino/library/model'
+
+module Arduino
+  module Library
+
+    # This class represents a single entry into the library-index.json file,
+    # in other words — a `library.properties` file.
+    class Database
+      extend Forwardable
+      include Utilities
+
+      def_delegators :@db_list, *(Array.new.methods - Object.methods)
+
+      class << self
+        alias from new
+
+        def default
+          @default ||= new
+        end
+      end
+
+      attr_accessor :local_file,
+                    :db_list
+
+      def initialize(file_or_url = Arduino::Library::DEFAULT_ARDUINO_LIBRARY_INDEX_URL)
+        self.local_file = read_file_or_url(file_or_url)
+        load_json
+      end
+
+      # Usage: find(attr1: value, attr2: /regexp/, ... )
+      def find(**opts)
+        limit = opts[:limit]
+        opts.delete(:limit)
+        match_list = []
+
+        db_list.find do |entry|
+          matches = entry_matches?(entry, opts)
+          match_list << entry if matches
+          break if limit && match_list.size >= limit
+        end
+
+        match_list.each { |entry| yield(entry) } if block_given?
+        match_list
+      end
+
+      private
+
+      def entry_matches?(entry, opts)
+        matches = true
+        opts.each_pair do |attr, check|
+          value   = entry.send(attr)
+          matches &= case check
+                      when String
+                        value == check
+                      when Regexp
+                        value =~ check
+                      when Array
+                        value = value.split(',') unless value.is_a?(Array)
+                        value.eql?(check) || value.include?(check) || value.first == '*'
+                      when Proc
+                        check.call(value)
+                      else
+                        raise InvalidArgument, "Class #{check.class.name} is unsupported for value checks"
+                    end
+          break unless matches
+        end
+      end
+
+      private
+
+      def load_json
+        hash = JSON.load(local_file.read)
+        self.db_list = hash['libraries'].map { |lib| Model.from_hash(lib) }
+      end
+    end
+  end
+end

data/lib/arduino/library/model.rb

@@ -0,0 +1,104 @@
+require_relative 'types'
+require_relative 'utilities'
+require 'json'
+
+module Arduino
+  module Library
+    # This class represents a single entry into the library-index.json file,
+    # in other words — a `library.properties` file.
+    class Model < Dry::Struct
+
+      # noinspection RubyResolve
+      constructor_type :symbolized
+
+      Types::LIBRARY_PROPERTIES.each_pair do |field, type|
+        self.attribute field, eval(type)
+      end
+
+      class << self
+        include Utilities
+
+        attr_writer :database
+
+        def from_hash(hash)
+          new(Types.schema[hash])
+        end
+
+        def from_json(json)
+          from_hash(JSON.load(json))
+        end
+
+        def from_json_file(file_or_url)
+          file  = read_file_or_url(file_or_url)
+          from_json(file.read)
+        end
+
+        def from_properties_file(file_or_url)
+          raise "File #{file_or_url} does not exist?" unless File.exist?(file_or_url)
+          Presenters::Properties.from(file_or_url)
+        end
+
+        def database
+          @database ||= Database.default
+        end
+
+        def find(**opts)
+          database.find(**opts)
+        end
+
+        # @param [Object] source — file name or a URL to JSON or .properties file
+        #
+        # ## Searching
+        #
+        # #### Database
+        #
+        # Searching requires a database, which can either be set via
+        #
+        #       Arduino::Library::Model.database = Database.from(file)
+        #
+        # otherwise it defaults to the default database, +Database.default+.
+        #
+        # @param [Hash] opts   — search parameters to the current database
+        #
+        # #### Query
+        #
+        # +opts+ is a Hash that you can use to pass attributes with values, any
+        # number of them. All matching results are returned as models from the
+        # current database.
+        #
+        #   name: 'AudioZero'
+        #   author: /konstantin/i              - regexp supported
+        #   architectures: [ 'avr' ]           - array is matched if it's a subset
+        #   version: proc do |value|           — or a proc for max flexibility
+        #     value.start_with?('1.') )
+        #   ends
+        #
+        # @return [Model | Array<Model> ] — array for search, otherwise a model
+        def from(source = nil, **opts)
+          case source
+            when Hash
+              from_hash(source)
+            when String
+              if source =~ /^{/m
+                from_json(source)
+              elsif File.exist?(source)
+                if source =~ /\.json(\.gz)?$/i
+                  from_json_file(source)
+                elsif source =~ /\.properties(\.gz)?$/i
+                  from_properties_file(source)
+                end
+              end
+            when NilClass
+              if opts && opts[:name] && opts[:version]
+                find(**opts)
+              end
+          end
+        end
+
+      end
+    end
+  end
+end
+
+
+require_relative 'presenters/properties'

data/lib/arduino/library/presenters/properties.rb

@@ -0,0 +1,63 @@
+require 'arduino/library/types'
+require 'arduino/library/model'
+
+module Arduino
+  module Library
+    module Presenters
+      class Properties < Struct.new(:model)
+        class << self
+          include ::Arduino::Library::Utilities
+          # Class method, that reads a properties file and returns a properly
+          # validated Arduino::Library::Model instance.
+          def from(file_or_url)
+            file  = read_file_or_url(file_or_url)
+            props = file.read.split(/\n/)
+            hash  = {}
+            props.each do |line|
+              attr, value = line.split('=')
+              attr        = attr.to_sym
+              if Types::ARRAY_ATTRIBUTES.include?(attr)
+                hash[attr] = value.split(',')
+              else
+                hash[attr] = value
+              end
+            end
+            ::Arduino::Library::Model.from_hash(hash)
+          end
+        end
+
+        attr_accessor :presented
+
+        def initialize(*args)
+          super(*args)
+          self.presented = ''
+        end
+
+        # Primary instance method, returns a string representing a
+        # library.properties format file, using the model.
+        # The presented value is cached in the #presented public instance
+        # variable.
+        def present
+          Types::LIBRARY_PROPERTIES.keys.each do |attr|
+            attribute_presenter(attr)
+          end
+          presented
+        end
+
+        private
+
+        def attribute_presenter(attr)
+          value = model.send(attr) if model && model.respond_to?(attr)
+          return unless value
+          if value.is_a?(Array)
+            self.presented << "#{attr}=#{model.send(attr).join(',')}\n"
+          else
+            self.presented << "#{attr}=#{model.send(attr)}\n"
+          end
+        end
+      end
+
+    end
+  end
+end
+

data/lib/arduino/library/types.rb

@@ -0,0 +1,109 @@
+require 'dry-types'
+require 'dry-struct'
+require 'uri'
+
+module Arduino
+  module Library
+    module Types
+      include Dry::Types.module
+
+      Name    = String.constrained format: /^[A-Za-z_.-][A-Za-z0-9 _.-]*[A-Za-z0-9_.-]$/
+      Version = String.constrained format: /[0-9]+\.[0-9]+(\.[0-9]+)?/
+
+      Url = String.constrained format: URI::regexp(%w(http https))
+
+      Category = String.enum('Display',
+                             'Signal Input/Output',
+                             'Communication',
+                             'Sensors',
+                             'Device Control',
+                             'Timing',
+                             'Data Storage',
+                             'Data Processing',
+                             'Other')
+
+      Architecture = String.enum(
+        '*',
+        'AVR',
+        'ESP8266',
+        'FP51',
+        'OpenBCI 32',
+        'RFduino',
+        'SAM',
+        'SAMD',
+        'STM32F1',
+        'Simblee',
+        'Simula',
+        'all',
+        'ameba',
+        'arc32',
+        'arm',
+        'atmelavr',
+        'avr',
+        'esp32',
+        'esp8266',
+        'nRF5',
+        'nRF51822',
+        'nRF52832',
+        'nrf52',
+        'pic32',
+        'rtl8195a',
+        'sam',
+        'samd',
+        'simblee',
+        'stm32',
+        'stm32f4',
+        'teensy',
+        'tiny')
+
+      LibraryTypes = String.enum(
+        'Arduino',
+        'Contributed',
+        'Partner',
+        'Recommended',
+        'Retired'
+      )
+
+      FileName = String.constrained(
+        format: /[a-zA-Z0-9_=.:]+/
+      )
+
+      Checksum = String.constrained(
+        format: /SHA-256:[0-9a-fA-F]{64}/
+      )
+
+      StringField = Coercible::String
+
+      LIBRARY_PROPERTIES = {
+        name:            'Types::String',
+        version:         'Types::String',
+        author:          'Types::String',
+        maintainer:      'Types::String',
+        sentence:        'Types::String',
+        paragraph:       'Types::String',
+        website:         'Types::Url',
+        category:        'Types::Category',
+        architectures:   'Types::Json::Array.member(Types::Architecture)',
+        types:           'Types::Json::Array.member(Types::LibraryTypes)',
+        url:             'Types::Url',
+        archiveFileName: 'Types::FileName',
+        size:            'Types::Coercible::Int',
+        checksum:        'Types::Checksum',
+        dot_a_linkage:   'Types::Bool.optional',
+        includes:        'Types::Json::Array.member(Types::FileName).optional',
+      }.freeze
+
+      ARRAY_ATTRIBUTES = LIBRARY_PROPERTIES.keys.select { |k| LIBRARY_PROPERTIES[k] =~ /Array/ }
+
+      class << self
+        attr_accessor :schema
+      end
+
+      # Let's keep the original hash intact; otherwise dry-struct munges it.
+      hash = LIBRARY_PROPERTIES.dup
+      hash.each { |attribute, type| hash[attribute] = eval(type) }
+
+      self.schema = Types::Hash.symbolized(hash)
+    end
+  end
+end

data/lib/arduino/library/utilities.rb

@@ -0,0 +1,19 @@
+require 'open-uri'
+
+module Arduino
+  module Library
+
+    module Utilities
+      def read_file_or_url(file_or_url)
+        raise ArgumentError, 'Empty file_or_url provided' unless file_or_url
+        temp_file = open(file_or_url)
+        if file_or_url =~ /\.gz$/i
+          Zlib::GzipReader.new(temp_file)
+        else
+          temp_file
+        end
+      end
+    end
+
+  end
+end

data/lib/arduino/library/version.rb

@@ -0,0 +1,8 @@
+module Arduino
+  module Library
+    VERSION = '0.3.0'
+    DESCRIPTION = <<-eof
+      This gem encapsulates many concepts related to how Arduino Libraries are indexed, how their metadata is validated, or .properties file generated. It supports searching the Arduino library database for any terms. This gem is used by Arli — Arduino Installer CLI toolkit.
+    eof
+  end
+end

metadata

@@ -0,0 +1,179 @@
+--- !ruby/object:Gem::Specification
+name: arduino-library
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+platform: ruby
+authors:
+- Konstantin Gredeskoul
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-10-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dry-configurable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: dry-types
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: dry-struct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !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: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: "      This gem encapsulates many concepts related to how Arduino Libraries
+  are indexed, how their metadata is validated, or .properties file generated. It
+  supports searching the Arduino library database for any terms. This gem is used
+  by Arli — Arduino Installer CLI toolkit.\n"
+email:
+- kigster@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- arduino-library.gemspec
+- bin/console
+- bin/setup
+- lib/arduino/library.rb
+- lib/arduino/library/database.rb
+- lib/arduino/library/model.rb
+- lib/arduino/library/presenters/properties.rb
+- lib/arduino/library/types.rb
+- lib/arduino/library/utilities.rb
+- lib/arduino/library/version.rb
+homepage: https://github.com/kigster/arduino-library
+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.6.11
+signing_key: 
+specification_version: 4
+summary: This gem encapsulates many concepts related to how Arduino Libraries are
+  indexed, how their metadata is validated, or .properties file generated. It supports
+  searching the Arduino library database for any terms. This gem is used by Arli —
+  Arduino Installer CLI toolkit.
+test_files: []