noun-project-api 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bb8a4380606b5d326ccc449f4a077194e6386631
-  data.tar.gz: 54a5dad9793a4ee4d0ed2bebd75a546285e2235d
+  metadata.gz: 0dcbb2c72c7cbc5df96879c43521e83d3016f70c
+  data.tar.gz: 7f6855dcc4b3f50824c83354401b7b3895a50cc5
 SHA512:
-  metadata.gz: a825ef76bc8e82cc2a6b7657e6f0b1a1bedff16370c682461c40238d5173d2b08e0f7c83aa1eebb7ab49c3d3545c7aa8f838793ee45e37d3ed40b004579196e8
-  data.tar.gz: a9e9ee20eba171b591213b651a47af9ad207fef400005ed8ae40fab7780876ba714b52797d16658252c6fad522eea09cfe06e4ec1e3c322e9578be47ed5c368b
+  metadata.gz: 60016d2253fe5e65ce2aec847d0c26d76e348baecf6f2b7c53e33eaca44bb97a2824d3d0abe495be68755bffc1ff394b2b1104dc132c19676d8f36d79243218a
+  data.tar.gz: 1951a91ccdf5b4e83be25c3612a84beb987a7af3d2de524d916eef2d142724cd76ea0262c35fd6de484c8380c403291051ac3b243d6f0f079a12e558f3bfb909

data/lib/noun-project-api.rb

@@ -1,10 +1,15 @@
 require 'oauth'
 require 'json'
+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'
 
+# Top level name space for the entire Gem.
 module NounProjectApi
+  API_BASE = 'http://api.thenounproject.com'
+
   def self.configuration
     @configuration ||=  Configuration.new
   end
@@ -14,6 +19,7 @@ module NounProjectApi
     yield(configuration) if block_given?
   end
 
+  # Main configuration class.
   class Configuration
     attr_accessor :public_domain
 

data/lib/noun-project-api/connection.rb

@@ -0,0 +1,14 @@
+module NounProjectApi
+  # Basic connection methods and setup.
+  module Connection
+    attr_accessor :token, :secret, :access_token
+
+    def initialize(token, secret)
+      @token = token
+      @secret = secret
+      fail(ArgumentError, 'Missing token or secret') unless @token && @secret
+
+      @access_token = OAuth::AccessToken.new(OAuth::Consumer.new(token, secret))
+    end
+  end
+end

data/lib/noun-project-api/icon.rb

@@ -1,35 +1,36 @@
 module NounProjectApi
+  # A single Icon as an abstracted ruby object.
   class Icon
     PREVIEW_SIZE_200 = 200
     PREVIEW_SIZE_42 = 42
     PREVIEW_SIZE_84 = 84
 
-    PUBLIC_DOMAIN_LICENSE = "public-domain"
+    PUBLIC_DOMAIN_LICENSE = 'public-domain'
 
     attr_accessor :original_hash
 
     def initialize(origin)
       origin = JSON.parse(origin) if origin.is_a? String
-      origin = origin.delete("icon") if origin.key? "icon"
+      origin = origin.delete('icon') if origin.key? 'icon'
 
       @original_hash = origin
     end
 
     def id
-      original_hash["id"].to_i
+      original_hash['id'].to_i
     end
 
     def public_domain?
-      original_hash["license_description"] == PUBLIC_DOMAIN_LICENSE
+      original_hash['license_description'] == PUBLIC_DOMAIN_LICENSE
     end
 
     def svg_url
-      original_hash["icon_url"]
+      original_hash['icon_url']
     end
 
     def preview_url(size = PREVIEW_SIZE_200)
       if size == PREVIEW_SIZE_200
-        original_hash["preview_url"]
+        original_hash['preview_url']
       else
         original_hash["preview_url_#{size}"]
       end

data/lib/noun-project-api/icon_retriever.rb

@@ -1,14 +1,16 @@
 require 'noun-project-api/retriever'
 
 module NounProjectApi
+  # Retrieve an icon.
   class IconRetriever < Retriever
-    API_PATH = "/icon/"
+    API_PATH = '/icon/'
 
+    # Find an icon based on it's id.
     def find(id)
-      raise ArgumentError.new('Missing id/slug') unless id
+      fail(ArgumentError, 'Missing id/slug') unless id
 
-      result = self.access_token.get("#{API_BASE}#{API_PATH}#{id}")
-      raise ArgumentError.new('Bad request') unless result.code == '200'
+      result = access_token.get("#{API_BASE}#{API_PATH}#{id}")
+      fail(ArgumentError, 'Bad request') unless result.code == '200'
 
       Icon.new(result.body)
     end

data/lib/noun-project-api/icons_retriever.rb

@@ -1,32 +1,40 @@
 require 'noun-project-api/retriever'
 
 module NounProjectApi
+  # Retrieve icons.
   class IconsRetriever < Retriever
-    API_PATH = "/icons/"
+    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)
-      raise ArgumentError.new('Missing search term') unless term
+      fail(ArgumentError, 'Missing search term') unless term
 
-      search = OAuth::Helper::escape(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 { |k, v| v.nil? }
-      if args.size > 0
-        args.each { |k, v| search += "&#{k}=#{v}" }
-      end
+      args = { 'limit' => limit, 'offset' => offset, 'page' => page }.reject { |_, v| v.nil? }
+      args.each { |k, v| search += "&#{k}=#{v}" } if args.size > 0
 
-      result = self.access_token.get("#{API_BASE}#{API_PATH}#{search}")
-      raise ArgumentError.new('Bad request') unless ['200', '404'].include? result.code
+      result = access_token.get("#{API_BASE}#{API_PATH}#{search}")
+      fail(ArgumentError, 'Bad request') unless %w(200 404).include? result.code
 
       if result.code == '200'
-        JSON.parse(result.body)["icons"].map { |icon| Icon.new(icon) }
+        JSON.parse(result.body)['icons'].map { |icon| Icon.new(icon) }
       else
         []
       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 { |k, v| v.nil? }
+      args = { 'limit' => limit, 'offset' => offset, 'page' => page }.reject { |k, v| v.nil? }
       if args.size > 0
         search = '?'
         args.each { |k, v| search += "#{k}=#{v}&" }
@@ -34,10 +42,10 @@ module NounProjectApi
         search = ''
       end
 
-      result = self.access_token.get("#{API_BASE}#{API_PATH}recent_uploads#{search}")
-      raise ArgumentError.new('Bad request') unless result.code == '200'
+      result = access_token.get("#{API_BASE}#{API_PATH}recent_uploads#{search}")
+      fail(ArgumentError, 'Bad request') unless result.code == '200'
 
-      JSON.parse(result.body)["recent_uploads"].map { |icon| Icon.new(icon) }
+      JSON.parse(result.body)['recent_uploads'].map { |icon| Icon.new(icon) }
     end
   end
 end

data/lib/noun-project-api/reporter.rb

@@ -0,0 +1,16 @@
+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?(Fixnum)
+      fail(ArgumentError, 'Missing ids') if ids.nil? || ids.empty?
+
+      result = access_token.post("#{API_BASE}#{API_PATH}", icons: ids.join(','))
+      result.code == '200'
+    end
+  end
+end

data/lib/noun-project-api/retriever.rb

@@ -1,14 +1,6 @@
 module NounProjectApi
-  API_BASE = 'http://api.thenounproject.com'
-
+  # A base class for different retriever classes.
   class Retriever
-    attr_accessor :token, :secret, :access_token
-    def initialize(token, secret)
-      @token = token
-      @secret = secret
-      raise ArgumentError.new('Missing token or secret') unless @token && @secret
-
-      @access_token = OAuth::AccessToken.new(OAuth::Consumer.new(token, secret))
-    end
+    include Connection
   end
 end

data/spec/lib/noun-project-api/reporter_spec.rb

@@ -0,0 +1,93 @@
+require 'spec_helper'
+
+RSpec.describe NounProjectApi::Reporter do
+  it 'raises an error when initialized without token' do
+    expect { NounProjectApi::Reporter.new(nil, Faker::Internet.password(16)) }.to raise_error(ArgumentError)
+  end
+
+  it 'raises an error when initialized without secret' do
+    expect { NounProjectApi::Reporter.new(Faker::Internet.password(16), nil) }.to raise_error(ArgumentError)
+  end
+
+  it 'initializes the values properly' do
+    token = Faker::Internet.password(16)
+    secret = Faker::Internet.password(16)
+    reporter = NounProjectApi::Reporter.new(token, secret)
+
+    expect(reporter.token).to eq(token)
+    expect(reporter.secret).to eq(secret)
+  end
+
+  context 'reports ids usage' do
+    before :each do
+      token = Faker::Internet.password(16)
+      secret = Faker::Internet.password(16)
+      @reporter = NounProjectApi::Reporter.new(token, secret)
+    end
+
+    it 'reports a singular id' do
+      valid_response = OpenStruct.new(
+        body: Fakes::Results::REPORTED_ONE,
+        code: '200'
+      )
+
+      id = 122
+
+      expect(@reporter.access_token).to receive(
+        :post
+      ).with(
+        "#{NounProjectApi::API_BASE}#{NounProjectApi::Reporter::API_PATH}",
+        icons: id.to_s
+      ).and_return(
+        valid_response
+      )
+
+      result = @reporter.report_used(id)
+      expect(result).to be true
+    end
+
+    it 'reports a singular id for a string' do
+      valid_response = OpenStruct.new(
+        body: Fakes::Results::REPORTED_ONE,
+        code: '200'
+      )
+
+      id = '122'
+
+      expect(@reporter.access_token).to receive(
+        :post
+      ).with(
+        "#{NounProjectApi::API_BASE}#{NounProjectApi::Reporter::API_PATH}",
+        icons: id
+      ).and_return(
+        valid_response
+      )
+
+      result = @reporter.report_used(id)
+      expect(result).to be true
+    end
+
+
+
+    it 'reports multiple ids' do
+      valid_response = OpenStruct.new(
+        body: Fakes::Results::REPORTED_ONE,
+        code: '200'
+      )
+
+      ids = [122, 4541, 342_11, 4352]
+
+      expect(@reporter.access_token).to receive(
+        :post
+      ).with(
+        "#{NounProjectApi::API_BASE}#{NounProjectApi::Reporter::API_PATH}",
+        icons: ids.join(',')
+      ).and_return(
+        valid_response
+      )
+
+      result = @reporter.report_used(ids)
+      expect(result).to be true
+    end
+  end
+end

data/spec/support/fakes.rb

@@ -296,5 +296,17 @@ module Fakes
         }
     ]
 }'''
+
+    REPORTED_ONE = '''
+{
+  "licenses_consumed": 1,
+  "result": "success"
+}'''
+
+    REPORTED_THREE = '''
+{
+  "licenses_consumed": 1,
+  "result": "success"
+}'''
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: noun-project-api
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Nadav Shatz
@@ -94,13 +94,16 @@ extra_rdoc_files: []
 files:
 - Rakefile
 - lib/noun-project-api.rb
+- lib/noun-project-api/connection.rb
 - lib/noun-project-api/icon.rb
 - lib/noun-project-api/icon_retriever.rb
 - lib/noun-project-api/icons_retriever.rb
+- lib/noun-project-api/reporter.rb
 - lib/noun-project-api/retriever.rb
 - spec/lib/noun-project-api/icon_retriever_spec.rb
 - spec/lib/noun-project-api/icon_spec.rb
 - spec/lib/noun-project-api/icons_retriever_spec.rb
+- spec/lib/noun-project-api/reporter_spec.rb
 - spec/lib/noun-project-api/retriever_spec.rb
 - spec/lib/nount_project_api_spec.rb
 - spec/spec_helper.rb
@@ -125,7 +128,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: An API wrapper for The Noun Project API's
@@ -133,6 +136,7 @@ test_files:
 - spec/lib/noun-project-api/icon_retriever_spec.rb
 - spec/lib/noun-project-api/icon_spec.rb
 - spec/lib/noun-project-api/icons_retriever_spec.rb
+- spec/lib/noun-project-api/reporter_spec.rb
 - spec/lib/noun-project-api/retriever_spec.rb
 - spec/lib/nount_project_api_spec.rb
 - spec/spec_helper.rb