flimb_api 0.0.1.pre

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9f70728efdc7911f9871600b44f58c2931fd6009
+  data.tar.gz: 4e7d712da8019ce834ebc883f4517c0601e58968
+SHA512:
+  metadata.gz: 3f3998925cb75c3233df61dd4a5451c5fe1e22fd3474e0920cadd6ce0f842a78baf726d1f745939d8da3ffa615f56c1c11bc4e6dbe26feed3df90be65141d94c
+  data.tar.gz: b46e82616f7bfc628037e004f52f660d9414b0a0b656ac910e889b7b7d559518214c21b9ee813e131ba499829604e996615e061882c9ccf975f20c12f47a46dc

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## 0.0.1
+
+* Initial release
+* Website, Alert, Scan
+

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development do
+  gem 'rake'
+  gem 'rspec'
+end

data/README.md

@@ -0,0 +1,21 @@
+# FlimbApi gem
+
+Flimb API client based on [ActiveResource](https://github.com/rails/activeresource).
+
+## Install
+
+Add to Gemfile:
+
+```ruby
+gem 'flimb_api'
+```
+
+## Use
+
+```ruby
+website = FlimbApi::Website.last
+website.enable_dnsbl = false
+website.save
+
+website.alerts.last
+```

data/Rakefile

@@ -0,0 +1,8 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+task :default => [:spec]
+task :test => [:spec]
+
+desc "Run all RSpec tests"
+RSpec::Core::RakeTask.new(:spec)

data/flimb_api.gemspec

@@ -0,0 +1,22 @@
+$:.push File.expand_path('../lib', __FILE__)
+require 'flimb_api/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'flimb_api'
+  s.version     = FlimbApi::VERSION::STRING
+  s.authors     = 'Flimb'
+  s.email       = 'contact@flimb.com'
+  s.homepage    = 'https://github.com/flimb/flimb_api'
+  s.summary     = 'Gem for accessing the Flimb REST web services'
+  s.description = 'Gem for accessing the Flimb REST web services'
+
+  s.rubyforge_project = 'flimb_api'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+
+  s.add_dependency('activesupport', ['>= 3.0.0'])
+  s.add_dependency('activeresource', ['>= 3.0.0'])
+  s.add_development_dependency 'rspec'
+end

data/lib/flimb.rb

@@ -0,0 +1,5 @@
+require 'flimb_api'
+
+module Flimb
+  extend ActiveSupport::Autoload
+end

data/lib/flimb_api.rb

@@ -0,0 +1,19 @@
+require 'active_support'
+require 'active_support/core_ext'
+require 'active_resource'
+
+module FlimbApi
+  extend ActiveSupport::Autoload
+
+  Deprecator = ActiveSupport::Deprecation.new('1.0', name)
+
+  eager_autoload do
+    autoload :VERSION
+    autoload :Base
+    autoload :Alert
+    autoload :Scan
+    autoload :Website
+  end
+end
+
+ActiveSupport.run_load_hooks('flimb_api', FlimbApi)

data/lib/flimb_api/alert.rb

@@ -0,0 +1,5 @@
+module FlimbApi
+  class Alert < Base;
+    belongs_to :website, class_name: 'flimb_api/alert'
+  end
+end

data/lib/flimb_api/base.rb

@@ -0,0 +1,18 @@
+require 'flimb_api/resource/countable'
+require 'flimb_api/resource/paginated'
+
+module FlimbApi
+  class Base < ActiveResource::Base
+    extend Resource::Countable
+    extend Resource::Paginated
+
+    self.include_root_in_json = true
+    self.headers['User-Agent'] = %W(
+      FlimbApi/#{FlimbApi::VERSION::STRING}
+      ActiveResource/#{ActiveResource::VERSION::STRING}
+      Ruby/#{RUBY_VERSION}).join(' ')
+    self.format = :json
+    self.prefix = '/api/'
+    self.site = 'https://flimb.com'
+  end
+end

data/lib/flimb_api/resource/countable.rb

@@ -0,0 +1,9 @@
+module FlimbApi
+  module Resource
+    module Countable
+      def count(options = {})
+        get(:count, options).to_i
+      end
+    end
+  end
+end

data/lib/flimb_api/resource/paginated.rb

@@ -0,0 +1,26 @@
+module FlimbApi
+  PER_PAGE_DEFAULT = 100
+
+  module Resource
+    module Paginated
+      def find_each(*args)
+        find_in_batches(*args) do |batch|
+          batch.each { |record| yield record }
+        end
+      end
+
+      def find_in_batches(options = {})
+        per_page = options[:per_page] || PER_PAGE_DEFAULT
+        params = {per_page: per_page}.merge(options[:params] || {})
+        page = 1
+        loop do
+          items = all(params: params.merge(page: page))
+          return unless items.any?
+          yield items
+          return if items.count < per_page
+          page += 1
+        end
+      end
+    end
+  end
+end

data/lib/flimb_api/scan.rb

@@ -0,0 +1,5 @@
+module FlimbApi
+  class Scan < Base
+    has_many :alerts, class_name: 'flimb_api/alert'
+  end
+end

data/lib/flimb_api/version.rb

@@ -0,0 +1,10 @@
+module FlimbApi
+  module VERSION
+    MAJOR = 0
+    MINOR = 0
+    TINY  = 1
+    PRE   = 'pre'
+
+    STRING = [MAJOR, MINOR, TINY, PRE].compact.join('.')
+  end
+end

data/lib/flimb_api/website.rb

@@ -0,0 +1,5 @@
+module FlimbApi
+  class Website < Base
+    has_many :alerts, class_name: 'flimb_api/alert'
+  end
+end

data/spec/lib/flimb_api/app_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe FlimbApi do
+
+  http_options = { 'Accept' => 'application/json',
+                   'User-Agent' => FlimbApi::Base.headers['User-Agent'] }
+
+  it 'returns websites' do
+    websites = [{ id: 1, name: 'example.com' }, { id: 2, name: 'example.org' }]
+    ActiveResource::HttpMock.respond_to do |mock|
+      mock.get '/api/websites.json', http_options, websites.to_json
+      mock.get '/api/websites/1.json', http_options, websites.first.to_json
+    end
+    FlimbApi::Website.all.size.should == 2
+    FlimbApi::Website.find(1).name.should == 'example.com'
+  end
+
+  it 'returns alerts' do
+    website = { id: 1, name: 'example.com' }
+    alerts = [{ id: 1, source: 'Dnsbl', state: 'unresolved' }]
+    ActiveResource::HttpMock.respond_to do |mock|
+      mock.get '/api/websites/1.json', http_options, website.to_json
+      mock.get '/api/alerts.json?website_id=1', http_options, alerts.to_json
+    end
+    FlimbApi::Website.find(1).alerts.first.source.should == 'Dnsbl'
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+# This file is copied to spec/ when you run 'rails generate rspec:install'
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'flimb_api'
+
+FlimbApi::Base.user     = nil
+FlimbApi::Base.password = nil
+
+RSpec.configure do |config|
+  # == Mock Framework
+  #
+  # If you prefer to use mocha, flexmock or RR, uncomment the appropriate line:
+  #
+  # config.mock_with :mocha
+  # config.mock_with :flexmock
+  # config.mock_with :rr
+  config.mock_with :rspec
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: flimb_api
+version: !ruby/object:Gem::Version
+  version: 0.0.1.pre
+platform: ruby
+authors:
+- Flimb
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: activeresource
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: Gem for accessing the Flimb REST web services
+email: contact@flimb.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- CHANGELOG.md
+- Gemfile
+- README.md
+- Rakefile
+- flimb_api.gemspec
+- lib/flimb.rb
+- lib/flimb_api.rb
+- lib/flimb_api/alert.rb
+- lib/flimb_api/base.rb
+- lib/flimb_api/resource/countable.rb
+- lib/flimb_api/resource/paginated.rb
+- lib/flimb_api/scan.rb
+- lib/flimb_api/version.rb
+- lib/flimb_api/website.rb
+- spec/lib/flimb_api/app_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/flimb/flimb_api
+licenses: []
+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: 1.3.1
+requirements: []
+rubyforge_project: flimb_api
+rubygems_version: 2.0.14
+signing_key: 
+specification_version: 4
+summary: Gem for accessing the Flimb REST web services
+test_files:
+- spec/lib/flimb_api/app_spec.rb
+- spec/spec_helper.rb