brocade_io 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2f2bcbd17b72290ed22df4ba0ebcee354e6b1a1a47cdf5ad2c72259679cae1f1
+  data.tar.gz: 8bd4b0e8c6e1609bca32671a04863b071639b02328c8780d6a240ac3d181aa55
+SHA512:
+  metadata.gz: cef03c811486a702d0429068017cb4e1d0a2c014ceac7ccb41dbb2844f187f4f3d6d7fcadede4552b9dc6827f9ef7dd665c7827f1d1bfcb9a6735f90c3a2d54a
+  data.tar.gz: 00ce8a6675e0513c7836da6b9c8a2b4218e0f291121109cacdbe2f8212a00f87b72eda915facabb213b0d21d8317b9178b4aed5670681c84c7e8a100062127fb

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## 0.0.1 (2014-03-02)
+
+- First release

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014-2019 Andrew Kane
+
+MIT License
+
+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,72 @@
+# BrocadeIo
+
+Ruby client for [Brocade.io](https://www.brocade.io/) - a free and open product database
+
+## Get Started
+
+Add this line to your application’s Gemfile:
+
+```ruby
+gem 'brocade_io'
+```
+
+Create a client
+
+```ruby
+brocade_io = BrocadeIo.new
+```
+
+Get an item
+
+```ruby
+item = brocade_io.item("013562610020") # or nil if not found
+item.gtin14
+item.brand_name
+item.name
+item.size
+```
+
+Create or update an item
+
+```ruby
+brocade_io.update_item("000000000000", {name: "Test"})
+```
+
+List items
+
+```ruby
+brocade_io.items
+```
+
+Returns the first 100 items.
+
+To get all items, use:
+
+```ruby
+brocade_io.paginated_items do |item|
+  item.gtin14
+end
+```
+
+Search items
+
+```ruby
+brocade_io.items(query: "peanut butter")
+```
+
+Add an image (NB not currently supported)
+
+```ruby
+image = Faraday::UploadIO.new("ice_cream.jpg", "image/jpeg")
+image_type = "scan" # or "photo"
+brocade_io.add_image("000000000000", image, image_type)
+```
+
+## Contributing
+
+Everyone is encouraged to help improve this project. Here are a few ways you can help:
+
+- [Report bugs](https://github.com/ferrisoxide/brocade_io/issues)
+- Fix bugs and [submit pull requests](https://github.com/ferrisoxide/brocade_io/pulls)
+- Write, clarify, or fix documentation
+- Suggest or add new features

data/lib/brocade_io.rb

@@ -0,0 +1,80 @@
+require "json"
+require "faraday"
+require "hashie"
+require "brocade_io/version"
+require "brocade_io/item"
+
+class BrocadeIo
+
+  def initialize(options = {})
+    @host = options[:host] || "https://www.brocade.io"
+    @version = options[:version] || 1
+  end
+
+  def item(gtin)
+    response = http_client.get("/api/items/#{gtin}?version=#{@version}")
+    if response.success?
+      Item.new(JSON.parse(response.body))
+    end
+  end
+
+  def update_item(gtin, attributes)
+    response = http_client.put("/api/items/#{gtin}?version=#{@version}", attributes)
+    if response.success?
+      Item.new(JSON.parse(response.body))
+    end
+  end
+
+  def add_image(gtin, image, image_type)
+    params = {
+      gtin: gtin,
+      image: image,
+      perspective: image_type
+    }
+    response = http_client.post("/api/items/#{gtin}/images?version=#{@version}", params)
+    if response.success?
+      JSON.parse(response.body)
+    end
+  end
+
+  def items(params = {})
+    response = http_client.get("/api/items?version=#{@version}", params)
+    if response.success?
+      JSON.parse(response.body).map do |item|
+        Item.new(item)
+      end
+    end
+  end
+
+  def paginated_items(params)
+    response = http_client.get("/api/items?version=#{@version}", params)
+    loop do
+      links = {}
+      if response.success?
+        JSON.parse(response.body).map do |item|
+          yield Item.new(item)
+        end
+
+        # https://gist.github.com/davidcelis/5896686
+        response.headers['Link'].to_s.split(',').each do |link|
+          link.strip!
+          parts = link.match(/<(.+)>; *rel="(.+)"/)
+          links[parts[2]] = parts[1]
+        end
+      end
+
+      break unless links["next"] && (response = http_client.get(links["next"]))
+    end
+  end
+
+  protected
+
+  def http_client
+    Faraday.new(url: @host) do |conn|
+      conn.request :multipart
+      conn.request :url_encoded
+      conn.adapter :net_http
+    end
+  end
+
+end

data/lib/brocade_io/item.rb

@@ -0,0 +1,4 @@
+class BrocadeIo
+  class Item < Hashie::Mash
+  end
+end

data/lib/brocade_io/version.rb

@@ -0,0 +1,3 @@
+class BrocadeIo
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: brocade_io
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Andrew Kane
+- Tom Tuddenham
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-04-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  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: hashie
+  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: bundler
+  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: rake
+  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: minitest
+  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: 
+email: ferrisoxide@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- lib/brocade_io.rb
+- lib/brocade_io/item.rb
+- lib/brocade_io/version.rb
+homepage: https://github.com/ferrisoxide/brocade_io
+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.4'
+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: Ruby client for Brocade.io
+test_files: []