kickfire 0.0.02

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 003c3179a986e77d669f136d833ffbca297795bc
+  data.tar.gz: c2b6d2fd09f4c3b6f6038980020a25b3f1b2a1ab
+SHA512:
+  metadata.gz: 18d91f07123bca95910789a128123a5614ffcb3bafaff16b972dfcd7fc80ff28cd3173ad465c54eba62828403f7e09f0006ed3c81e1f640327839a0e87444ba8
+  data.tar.gz: 51b8b6cf1a3d0f79619fd83ae3256147acfd9ec81f061c9670f1f72b79a947fc50eb7b5ffd1ca36219cc559bfa58fbe9f66c48f09f79d3d6b3074b2b938c34c5

data/Gemfile

@@ -0,0 +1,12 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ttdrest.gemspec
+gemspec
+
+gem 'rspec'
+gem 'httparty'
+gem 'activesupport'
+gem 'webmock'
+gem 'vcr'
+gem 'pry'
+gem 'byebug'

data/README.md

@@ -0,0 +1,53 @@
+# Kick Fire Ruby
+Ruby Gem for talking to the Kickfire api
+
+Kickfire provides information about a company or ip address, including
+address and social data.
+
+### Setup
+Put your kickfire api key in `config/initializers/kickfire.rb` as a constant,
+like
+
+```ruby
+module Kickfire
+ API_KEY = 'valid_api_key_here'
+end
+```
+
+### Usage
+```ruby
+Kickfire::Company.find("#{ip_address_of_company to look up}")
+#
+# an instance of KickFire::Company with public methods based on results
+#
+
+```
+#### Public methods
+ * cid  
+ * name  
+ * website  
+ * street  
+ * city  
+ * regionShort  
+ * region  
+ * postal  
+ * countryShort  
+ * country  
+ * phone  
+ * employees  
+ * revenue  
+ * category  
+ * site_code  
+ * category2  
+ * naics_code  
+ * longitude  
+ * lattitude  
+ * stock_symbol  
+ * facebook  
+ * twitter  
+ * linkedin  
+ * linedkin_id  
+ * isp  
+ * to_json  
+ * twitter_url  
+ * address

data/Rakefile

@@ -0,0 +1,12 @@
+require "bundler/gem_tasks"
+
+Bundler::GemHelper.install_tasks
+
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+desc "Run all specs"
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.pattern = "./spec/**/*_spec.rb"
+end

data/lib/kickfire.rb

@@ -0,0 +1,13 @@
+require 'httparty'
+require 'uri'
+
+require 'active_support'
+require 'active_support/core_ext/object/blank'
+
+# Set our version number
+require 'kickfire/version'
+require 'kickfire/error'
+require 'kickfire/company'
+
+module Kickfire
+end

data/lib/kickfire/company.rb

@@ -0,0 +1,85 @@
+module Kickfire
+  class Company
+    BASE_URL = "https://api.kickfire.com/v2/"
+    BASE_QUERY = "company:(all)"
+
+    def initialize(attributes = nil)
+      if attributes.kind_of?(Array) && attributes.first
+        attributes = attributes.first
+      end
+
+      if attributes.kind_of?(Hash)
+        @raw = attributes
+        attributes.each do |k,v|
+          instance_variable_set("@#{k.to_s.underscore}", v)
+        end
+      elsif attributes.kind_of? String
+        Kickfire::Company.find(attributes)
+      end
+    end
+
+    def self.find(ip, api_key: nil)
+      if !api_key
+        if defined? Kickfire::API_KEY
+          api_key = Kickfire::API_KEY
+        end
+      end
+
+      uri = URI("#{BASE_URL}#{BASE_QUERY}")
+      params = { ip: ip, key: api_key }
+      uri.query = URI.encode_www_form(params)
+      response = ::HTTParty.get(uri)
+
+      if !response
+        raise Kickfire::Error.new('No data returned from Kickfire')
+      elsif response['status'] == 'error'
+        Kickfire::Error.find(response['code'],response['message'])
+      elsif response['status'] == 'not found'
+        nil
+      else
+        new(response['data'])
+      end
+    end
+
+    attr_reader :cid
+    attr_reader :name
+    attr_reader :website
+    attr_reader :street
+    attr_reader :city
+    attr_reader :regionShort
+    attr_reader :region
+    attr_reader :postal
+    attr_reader :countryShort
+    attr_reader :country
+    attr_reader :phone
+    attr_reader :employees
+    attr_reader :revenue
+    attr_reader :category
+    attr_reader :site_code
+    attr_reader :category2
+    attr_reader :naics_code
+    attr_reader :longitude
+    attr_reader :lattitude
+    attr_reader :stock_symbol
+    attr_reader :facebook
+    attr_reader :twitter
+    attr_reader :linkedin
+    attr_reader :linedkin_id
+
+    def isp?
+      @is_isp == 1
+    end
+
+    def twitter_url
+      "http://twitter.com/" + twitter
+    end
+
+    def address
+      [street, city, regionShort, postal].compact.join ", "
+    end
+
+    def to_json
+      @raw.to_json
+    end
+  end
+end

data/lib/kickfire/error.rb

@@ -0,0 +1,21 @@
+module Kickfire
+  class Error < StandardError
+    def self.find(code,message)
+      if  code.to_s.index("90")
+        raise Kickfire::AuthenticationError.new("#{code} #{message}")
+      elsif code.to_s.index("10")
+        raise Kickfire::AccountLimitError.new("#{code} #{message}")
+      elsif code.to_s.index("20") || code.to_s.index("20")
+        raise Kickfire::RequestError.new("#{code} #{message}")
+      else
+        raise Kickfire::Error.new("#{code} #{message}")
+      end
+    end
+  end
+  class AuthenticationError < Error
+  end
+  class AccountLimitError < Error
+  end
+  class RequestError < Error
+  end
+end

data/lib/kickfire/version.rb

@@ -0,0 +1,3 @@
+module Kickfire
+  VERSION = "0.0.02"
+end

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification
+name: kickfire
+version: !ruby/object:Gem::Version
+  version: 0.0.02
+platform: ruby
+authors:
+- Stephen Reid
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-12-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  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: activesupport
+  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.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !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: vcr
+  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: webmock
+  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:
+- stephen.reid@terminus.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- README.md
+- Rakefile
+- lib/kickfire.rb
+- lib/kickfire/company.rb
+- lib/kickfire/error.rb
+- lib/kickfire/version.rb
+homepage: ''
+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.4.8
+signing_key: 
+specification_version: 4
+summary: Kickfire API Client
+test_files: []