noun-project-api 0.2.2 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 11f21fc8fa8332fb270247aba04d4ac778c5cff9
-  data.tar.gz: 9cf63e9099b5f9b1b777aa0191cf80fd516b3b90
+SHA256:
+  metadata.gz: 7599a88ab282cc57200c3907a08b057d466d91af307c992c42fa59ca15bdbe55
+  data.tar.gz: cee01ba5d89c09fb74b62c7ef2b5d630437632ce6c43406b5d65b2fd417c544b
 SHA512:
-  metadata.gz: 1d1e4725b6dd873d4f4f66cc9d0636123196cbd02a4b090d3fdf548df54d2ecc40b16eecac4050c2e6bbb6e9b190f84f4706cfbf4d04c5391b85bab302d715de
-  data.tar.gz: 5ade878aa4c75eb4cd0e0875be509fd381381ce090789784307f8e5f6e74631a23b9097f05a837300200b4547aeeabef5ce9148e7f43952c6e2dd6098c9e0ea0
+  metadata.gz: bf81da78826aee4244949577e0b103b1dc16435e813115576b81701d72a31a4569e78cc85ec5cd7e921666e12392f18aff9fd02dd9f3ec1d2a006e21cb7c341b
+  data.tar.gz: de4ab0a45285f4979c697beff40d1f02ff497a9d4037487172000cede3ca46f20a47c2a51b8d635ddc9a478d3b0a6cdba07dba8b3417311b6cbc75df73491140

data/Rakefile

@@ -1,14 +1,16 @@
-require 'bundler'
+# frozen_string_literal: true
+
+require "bundler"
 Bundler::GemHelper.install_tasks
 
-$:.unshift 'lib'
+$LOAD_PATH.unshift "lib"
 
-desc 'Default: run unit tests.'
-task :default => [:spec]
+desc "Default: run unit tests."
+task default: [:spec]
 
-require 'rspec/core/rake_task'
+require "rspec/core/rake_task"
 
-desc 'Run specs'
+desc "Run specs"
 RSpec::Core::RakeTask.new do |t|
-  t.pattern = './spec/**/*_spec.rb'
+  t.pattern = "./spec/**/*_spec.rb"
 end

data/lib/noun_project_api.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require "oauth"
+require "active_support"
+require "json"
+require "noun_project_api/errors"
+require "noun_project_api/connection"
+require "noun_project_api/icon_retriever"
+require "noun_project_api/reporter"
+require "noun_project_api/icons_retriever"
+require "noun_project_api/icon"
+require "noun_project_api/collection_retriever"
+require "noun_project_api/collection"
+
+# Top level name space for the entire Gem.
+module NounProjectApi
+  API_BASE = "http://api.thenounproject.com"
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration) if block_given?
+  end
+
+  # Main configuration class.
+  class Configuration
+    attr_accessor :public_domain, :cache, :cache_ttl
+
+    def initialize
+      @public_domain = false
+      @cache = ActiveSupport::Cache::NullStore.new
+      @cache_ttl = 604800 # Week in seconds
+    end
+  end
+end

data/lib/noun_project_api/base_item.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module NounProjectApi
+  # A basis to Items returned by the noun project.
+  class BaseItem
+    attr_accessor :original_hash
+    ITEM_NAME = nil
+
+    def initialize(origin)
+      raise NotImplementedError, "Must use a subclass" if self.class::ITEM_NAME.nil?
+
+      origin = JSON.parse(origin, symbolize_names: true) if origin.is_a? String
+      if origin.key? self.class::ITEM_NAME
+        origin = origin.delete(
+          self.class::ITEM_NAME
+        )
+      end
+
+      @original_hash = origin
+    end
+
+    def id
+      original_hash[:id].to_i
+    end
+
+    def to_json(*_args)
+      JSON.dump(to_hash)
+    end
+  end
+end

data/lib/noun_project_api/collection.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require "noun_project_api/base_item"
+
+module NounProjectApi
+  # A single Collection as an abstracted ruby object.
+  class Collection < BaseItem
+    ITEM_NAME = :collection
+
+    def author_id
+      original_hash[:author_id].to_i
+    end
+
+    def author_name
+      original_hash[:author][:name]
+    end
+
+    def icon_count
+      original_hash[:icon_count].to_i
+    end
+
+    def published?
+      original_hash[:is_published].to_i == 1
+    end
+
+    def to_hash
+      {
+        id: id,
+        author_id: author_id,
+        author_name: author_name,
+        icon_count: icon_count,
+        published: published?
+      }
+    end
+  end
+end

data/lib/noun_project_api/collection_retriever.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require "noun_project_api/collection"
+require "noun_project_api/retriever"
+
+module NounProjectApi
+  # Retrieve a collection.
+  class CollectionRetriever < Retriever
+    API_PATH = "/collection/"
+    ITEM_CLASS = Collection
+
+    alias find_by_slug find
+  end
+end

data/lib/{noun-project-api → noun_project_api}/connection.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module NounProjectApi
   # Basic connection methods and setup.
   module Connection
@@ -6,7 +8,7 @@ module NounProjectApi
     def initialize(token, secret)
       @token = token
       @secret = secret
-      fail(ArgumentError, 'Missing token or secret') unless @token && @secret
+      raise ArgumentError, "Missing token or secret" unless @token && @secret
 
       @access_token = OAuth::AccessToken.new(OAuth::Consumer.new(token, secret))
     end

data/lib/noun_project_api/errors.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module NounProjectApi
+  class ServiceError < StandardError
+    attr_reader :status, :body
+
+    def initialize(status, body)
+      @status = status
+      @body = body
+
+      super("Noun Project API Error")
+    end
+  end
+end

data/lib/noun_project_api/icon.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require "noun_project_api/base_item"
+
+module NounProjectApi
+  # A single Icon as an abstracted ruby object.
+  class Icon < BaseItem
+    PREVIEW_SIZE_200 = 200
+    PREVIEW_SIZE_42 = 42
+    PREVIEW_SIZE_84 = 84
+
+    PUBLIC_DOMAIN_LICENSE = "public-domain"
+
+    ITEM_NAME = :icon
+
+    def public_domain?
+      original_hash[:license_description] == PUBLIC_DOMAIN_LICENSE
+    end
+
+    def svg_url
+      original_hash[:icon_url]
+    end
+
+    def preview_url(size = PREVIEW_SIZE_200)
+      if size == PREVIEW_SIZE_200
+        original_hash[:preview_url]
+      else
+        original_hash[:"preview_url_#{size}"]
+      end
+    end
+
+    def to_hash
+      {
+        id: id,
+        preview_url_200: preview_url(PREVIEW_SIZE_200),
+        preview_url_84: preview_url(PREVIEW_SIZE_84),
+        preview_url_42: preview_url(PREVIEW_SIZE_42)
+      }
+    end
+  end
+end

data/lib/noun_project_api/icon_retriever.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require "noun_project_api/icon"
+require "noun_project_api/retriever"
+
+module NounProjectApi
+  # Retrieve an icon.
+  class IconRetriever < Retriever
+    API_PATH = "/icon/"
+    ITEM_CLASS = Icon
+
+    alias find_by_slug find
+  end
+end

data/lib/noun_project_api/icons_retriever.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require "noun_project_api/retriever"
+
+module NounProjectApi
+  # Retrieve icons.
+  class IconsRetriever < Retriever
+    API_PATH = "/icons/"
+
+    # Finds multiple icons based on the term
+    # * term - search term
+    # * limit - limit the amount of results
+    # * offset - offset the results
+    # * page - page number
+    def find(term, limit = nil, offset = nil, page = nil)
+      cache_key = Digest::MD5.hexdigest("#{term}+#{limit}+#{offset}+#{page}")
+      cache_ttl = NounProjectApi.configuration.cache_ttl
+
+      NounProjectApi.configuration.cache.fetch(cache_key, expires_in: cache_ttl) do
+        raise ArgumentError, "Missing search term" unless term
+
+        search = OAuth::Helper.escape(term)
+        search += "?limit_to_public_domain=#{NounProjectApi.configuration.public_domain ? 1 : 0}"
+
+        args = {
+          "limit" => limit,
+          "offset" => offset,
+          "page" => page
+        }.reject { |_, v| v.nil? }
+        args.each { |k, v| search += "&#{k}=#{v}" } unless args.empty?
+
+        result = access_token.get("#{API_BASE}#{API_PATH}#{search}")
+        raise ServiceError.new(result.code, result.body) unless ["200", "404"].include? result.code
+
+        if result.code == "200"
+          JSON.parse(result.body, symbolize_names: true)[:icons].map { |icon| Icon.new(icon) }
+        else
+          []
+        end
+      end
+    end
+
+    # List recent uploads
+    # * limit - limit the amount of results
+    # * offset - offset the results
+    # * page - page number
+    def recent_uploads(limit = nil, offset = nil, page = nil)
+      args = {
+        "limit" => limit,
+        "offset" => offset,
+        "page" => page
+      }.reject { |_, v| v.nil? }
+      if !args.empty?
+        search = "?"
+        args.each { |k, v| search += "#{k}=#{v}&" }
+      else
+        search = ""
+      end
+
+      result = access_token.get("#{API_BASE}#{API_PATH}recent_uploads#{search}")
+      raise ServiceError.new(result.code, result.body) unless result.code == "200"
+
+      JSON.parse(result.body, symbolize_names: true)[:recent_uploads].map { |icon| Icon.new(icon) }
+    end
+  end
+end

data/lib/noun_project_api/reporter.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module NounProjectApi
+  # Main class to hold reporting actions back to the Noun Project.
+  class Reporter
+    include Connection
+
+    API_PATH = "/notify/publish"
+
+    def report_used(ids)
+      ids = [ids] if ids.is_a?(String) || ids.is_a?(Integer)
+      raise ArgumentError, "Missing ids" if ids.nil? || ids.empty?
+
+      result = access_token.post(
+        "#{API_BASE}#{API_PATH}",
+        { icons: ids.join(",") }.to_json,
+        "Accept" => "application/json", "Content-Type" => "application/json"
+      )
+      result.code == "200"
+    end
+  end
+end

data/lib/noun_project_api/retriever.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module NounProjectApi
+  # A base class for different retriever classes.
+  class Retriever
+    include Connection
+
+    # Find an item based on it's id.
+    def find(id)
+      raise ArgumentError, "Missing id/slug" unless id
+
+      result = access_token.get("#{API_BASE}#{self.class::API_PATH}#{id}")
+      raise ServiceError.new(result.code, result.body) unless result.code == "200"
+
+      self.class::ITEM_CLASS.new(result.body)
+    end
+  end
+end

data/spec/lib/noun_project_api/base_item_spec.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+require "ostruct"
+
+RSpec.describe NounProjectApi::BaseItem do
+  it "raises an error on direct initialization" do
+    data = JSON.parse(Fakes::Results::ICON_VALID)
+    expect {
+      NounProjectApi::BaseItem.new(JSON.dump(data["icon"]))
+    }.to raise_error(NotImplementedError)
+  end
+end

data/spec/lib/noun_project_api/collection_retriever_spec.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+require "ostruct"
+
+RSpec.describe NounProjectApi::CollectionRetriever do
+  before :each do
+    @collection = NounProjectApi::CollectionRetriever.new(Faker::Internet.password(min_length: 16), Faker::Internet.password(min_length: 16))
+    @valid_hash = JSON.parse(Fakes::Results::COLLECTION_VALID, symbolize_names: true)
+    @valid_response = OpenStruct.new(
+      body: Fakes::Results::COLLECTION_VALID,
+      code: "200"
+    )
+
+    @missing_response = OpenStruct.new(
+      code: "404"
+    )
+  end
+
+  context "id" do
+    it "raises an error when no id is provided" do
+      expect { @collection.find(nil) }.to raise_error(ArgumentError)
+    end
+
+    it "returns a proper result with a correct id" do
+      id = 1
+      expect(@collection.access_token).to receive(
+        :get
+      ).with(
+        "#{NounProjectApi::API_BASE}#{NounProjectApi::CollectionRetriever::API_PATH}#{id}"
+      ).and_return(
+        @valid_response
+      )
+
+      result = @collection.find(id)
+      expect(result).to be_a(NounProjectApi::Collection)
+      expect(result.original_hash).to eq(@valid_hash[:collection])
+    end
+
+    it "raises an error with a missing id" do
+      id = 1
+      expect(@collection.access_token).to receive(
+        :get
+      ).with(
+        "#{NounProjectApi::API_BASE}#{NounProjectApi::CollectionRetriever::API_PATH}#{id}"
+      ).and_return(
+        @missing_response
+      )
+
+      expect { @collection.find(id) }.to raise_error(NounProjectApi::ServiceError)
+    end
+  end
+
+  context "slug" do
+    it "raises an error when no slug is provided" do
+      expect { @collection.find_by_slug(nil) }.to raise_error(ArgumentError)
+    end
+
+    it "returns a proper result with a correct slug" do
+      slug = "existing_slug"
+      expect(@collection.access_token).to receive(
+        :get
+      ).with(
+        "#{NounProjectApi::API_BASE}#{NounProjectApi::CollectionRetriever::API_PATH}#{slug}"
+      ).and_return(
+        @valid_response
+      )
+
+      result = @collection.find(slug)
+      expect(result).to be_a(NounProjectApi::Collection)
+      expect(result.original_hash).to eq(@valid_hash[:collection])
+    end
+
+    it "raises an error with a missing slug" do
+      slug = "missing_slug"
+      expect(@collection.access_token).to receive(
+        :get
+      ).with(
+        "#{NounProjectApi::API_BASE}#{NounProjectApi::CollectionRetriever::API_PATH}#{slug}"
+      ).and_return(
+        @missing_response
+      )
+
+      expect { @collection.find_by_slug(slug) }.to raise_error(NounProjectApi::ServiceError)
+    end
+  end
+end