datakick 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 63d3362ff6faa2dd896fd5f1d8781ad00dad45eb
+  data.tar.gz: e8940d3a8b3906431897f58e56857fe593be20fb
+SHA512:
+  metadata.gz: e6e4eddc8f4a752058698ff038a3f418d41e31f89a408fdac83538b89b0c4d4901deb351a857f196406b29ac6dbb8e27fd96890c39b546a72fae9188a923f379
+  data.tar.gz: d1e6fc808752deb657dff2848d036bce9ec428ac1046e2024cd43d5bf7197b7dfc470541c3b12f3dc70c92ad74bcb5640a7d63818ce3cce88153ecfd0398f8e3

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in datakick.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 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 @@
+# Datakick
+
+Ruby client for [Datakick](https://www.datakick.org/) - the open product database
+
+## Get Started
+
+Add this line to your application’s Gemfile:
+
+```ruby
+gem 'datakick'
+```
+
+Create a client
+
+```ruby
+datakick = Datakick.new
+```
+
+Get an item
+
+```ruby
+item = datakick.item("013562610020") # or nil if not found
+item.gtin14
+item.brand_name
+item.name
+item.size
+```
+
+Create or update an item
+
+```ruby
+datakick.update_item("000000000000", {name: "Test"})
+```
+
+List items
+
+```ruby
+datakick.items
+```
+
+Returns the first 100 items.
+
+To get all items, use:
+
+```ruby
+datakick.paginated_items do |item|
+  item.gtin14
+end
+```
+
+Search items
+
+```ruby
+datakick.items(query: "peanut butter")
+```
+
+Add an image
+
+```ruby
+image = Faraday::UploadIO.new("ice_cream.jpg", "image/jpeg")
+image_type = "scan" # or "photo"
+datakick.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/ankane/datakick/issues)
+- Fix bugs and [submit pull requests](https://github.com/ankane/datakick/pulls)
+- Write, clarify, or fix documentation
+- Suggest or add new features

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+task :default => :test
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.pattern = "test/**/*_test.rb"
+end

data/datakick.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'datakick/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "datakick"
+  spec.version       = Datakick::VERSION
+  spec.authors       = ["Andrew Kane"]
+  spec.email         = ["andrew@datakick.org"]
+  spec.summary       = %q{Ruby client for Datakick - the open product database}
+  spec.description   = %q{Ruby client for Datakick - the open product database}
+  spec.homepage      = "https://github.com/ankane/datakick-rb"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "faraday"
+  spec.add_dependency "hashie"
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest"
+end

data/lib/datakick.rb

@@ -0,0 +1,80 @@
+require "json"
+require "faraday"
+require "hashie"
+require "datakick/version"
+require "datakick/item"
+
+class Datakick
+  API_VERSION = 1
+  # API_HOST = "http://0.0.0.0:5000"
+  API_HOST = "https://www.datakick.org"
+
+  def initialize
+  end
+
+  def item(gtin)
+    response = http_client.get("/api/items/#{gtin}?version=#{API_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=#{API_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=#{API_VERSION}", params)
+    if response.success?
+      JSON.parse(response.body)
+    end
+  end
+
+  def items(params = {})
+    response = http_client.get("/api/items?version=#{API_VERSION}", params)
+    if response.success?
+      JSON.parse(response.body).map do |item|
+        Item.new(item)
+      end
+    end
+  end
+
+  def paginated_items(params, &block)
+    response = http_client.get("/api/items?version=#{API_VERSION}", params)
+    begin
+      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
+      # p links
+    end while links["next"] and (response = http_client.get(links["next"]))
+  end
+
+  protected
+
+  def http_client
+    Faraday.new(url: API_HOST) do |conn|
+      conn.request :multipart
+      conn.request :url_encoded
+      conn.adapter :net_http
+    end
+  end
+
+end

data/lib/datakick/item.rb

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

data/lib/datakick/version.rb

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

data/test/datakick_test.rb

@@ -0,0 +1,49 @@
+require_relative "test_helper"
+
+class TestDatakick < Minitest::Test
+
+  def test_item
+    item = datakick.item("000000000000")
+    assert_equal "00000000000000", item.gtin14
+  end
+
+  def test_item_not_found
+    assert_nil datakick.item("000000000001")
+  end
+
+  def test_update_item
+    name = "Test #{rand(100)}"
+    item = datakick.update_item("000000000000", {name: name})
+    assert_equal name, item.name
+  end
+
+  def test_add_image
+    image = Faraday::UploadIO.new("/Users/andrew/Desktop/ice_cream.jpg", "image/jpeg")
+    assert datakick.add_image("000000000000", image, "photo")
+  end
+
+  def test_items
+    assert_kind_of Array, datakick.items
+  end
+
+  def test_items_query
+    assert_kind_of Array, datakick.items(query: "test")
+  end
+
+  def test_paginated_items
+    items = []
+    datakick.paginated_items(per_page: 1000) do |item|
+      # p item
+      items << item
+    end
+    # p items.size
+    assert_kind_of Array, items
+  end
+
+  protected
+
+  def datakick
+    Datakick.new
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,4 @@
+require "bundler/setup"
+Bundler.require(:default)
+require "minitest/autorun"
+require "minitest/pride"

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: datakick
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Andrew Kane
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-03 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: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !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: Ruby client for Datakick - the open product database
+email:
+- andrew@datakick.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- datakick.gemspec
+- lib/datakick.rb
+- lib/datakick/item.rb
+- lib/datakick/version.rb
+- test/datakick_test.rb
+- test/test_helper.rb
+homepage: https://github.com/ankane/datakick-rb
+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.2.0
+signing_key: 
+specification_version: 4
+summary: Ruby client for Datakick - the open product database
+test_files:
+- test/datakick_test.rb
+- test/test_helper.rb