linkbucks 0.0.1

data/.document

@@ -0,0 +1,4 @@
+lib/**/*.rb
+bin/*
+- 
+LICENSE.txt

data/.rspec

@@ -0,0 +1,2 @@
+--format doc
+--color

data/.yardopts

@@ -0,0 +1,3 @@
+--markup markdown
+-
+README.md

data/Gemfile

@@ -0,0 +1,14 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "yard"
+  gem "bundler", "~> 1.0"
+  gem "jeweler", "~> 2.0.1"
+  gem "rspec"
+  gem "webmock"
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2014 pacop
+
+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,33 @@
+# Linkbucks
+
+Unofficial API Wrapper for Linkbucks.com
+
+## Some examples
+  
+```  
+linkbucks = Linkbucks::API.new USER, PASSWORD
+linkbucks.create_link_single originalLink: 'http://www.google.es'
+=> {"linkId"=>82924, "link"=>"http://www.linkbucks.com/987d3"}
+```
+
+You can specify adType or contentType
+
+```
+linkbucks.create_link_single originalLink: 'http://www.google.es', adType: :intermission, contentType: :clean
+```
+
+## Contributing to linkbucks
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+
+## Copyright
+
+Copyright (c) 2014 pacop. See LICENSE.txt for
+further details.

data/Rakefile

@@ -0,0 +1,38 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://guides.rubygems.org/specification-reference/ for more options
+  gem.name = "linkbucks"
+  gem.email = "pacopa.93@gmail.com"
+  gem.homepage = "http://github.com/pacop/linkbucks"
+  gem.license = "MIT"
+  gem.summary = %Q{Unofficial API Wrapper for Linkbucks.com}
+  gem.description = %Q{Unofficial API Wrapper for Linkbucks.com}
+  gem.email = "pacopa.93@gmail.com"
+  gem.authors = ["pacop"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task :test => :spec
+
+require 'yard'
+YARD::Rake::YardocTask.new
+
+
+task :default => [:spec]

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/lib/linkbucks.rb

@@ -0,0 +1,2 @@
+require 'linkbucks/error'
+require 'linkbucks/linkbucks'

data/lib/linkbucks/error.rb

@@ -0,0 +1,5 @@
+module Linkbucks
+  class AuthenticationFailed < StandardError; end
+  class ValidationFailed < StandardError; end
+  class OperationFailed < StandardError; end
+end

data/lib/linkbucks/linkbucks.rb

@@ -0,0 +1,81 @@
+require 'net/http'
+require 'net/https'
+require 'json'
+
+module Linkbucks
+  # Unofficial API Wrapper for Linkbucks.com
+  class API
+
+    # Unique url API
+    URL_API = 'https://www.linkbucks.com/api/createLink/single'
+
+    # Valid content types
+    CONTENT_TYPE = {clean: 1, adult: 2}
+
+    # Valid ad types
+    AD_TYPE = {intermission: 2, locker: 4, shortLink: 5}
+
+    # Create instance to use API linkbucks
+    #
+    # If you want to get apiPassword see http://www.linkbucks.com/Profile
+    #
+    # @param user [String] Username
+    # @param pass [String] API password
+    def initialize user, pass
+      @user, @pass = user, pass
+    end
+
+    # Create single link
+    #
+    # Maybe you want to see http://www.linkbucks.com/CreateLinks/Tools
+    #
+    # @param data [Hash] data to send api
+    #
+    # @option data [String] :originalLink Link to be converted
+    # @option data [Symbol] :adType Type of advertisement {AD_TYPE See valid adTypes}
+    # @option data [Symbol] :contenType Type of page content {CONTENT_TYPE See valid contentType}
+    # @option data [String] :domain Alias domain to be used for ther generated link
+    #
+    # @example Simple use
+    #   linkbucks.create_link_single(originalLink: 'http://www.google.es')['link']
+    #
+    # @return [Hash] Id and link
+    #
+    # @raise [AuthenticationFailed] user and apiPassword doesn't match
+    # @raise [ValidationFailed] when supplied data didn't pass validation.
+    # @raise [OperationFailed] Indicates processing error
+    # @raise [ArgumentError] Invalid parameters
+    # @raise [StandardError] Unknown error
+    def create_link_single data
+      data = {contentType: CONTENT_TYPE[:clean], adType: AD_TYPE[:intermission], domain: 'linkbucks.com'}.merge(data)
+
+      body = https_post URL_API, {user: @user, apiPassword: @pass}.merge(data)
+      body = JSON.parse body  
+
+      return body unless body.include? 'errorCode'
+
+      case body['errorCode']
+      when 1
+        raise AuthenticationFailed, body['errorDescription']
+      when 2
+        raise ArgumentError, body['errorDescription']
+      when 3
+        raise ValidationFailed, body['errorDescription']
+      when 4
+        raise OperationFailed, body['errorDescription']
+      else
+        raise StandardError
+      end
+    end
+
+    private
+    def https_post url, data
+      uri = URI.parse(url)
+      https = Net::HTTP.new(uri.host, uri.port)
+      https.use_ssl = true
+      req = Net::HTTP::Post.new(uri.path)
+      req.body = data.to_json
+      https.request(req).body
+    end
+  end
+end

data/linkbucks.gemspec

@@ -0,0 +1,65 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "linkbucks"
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["pacop"]
+  s.date = "2014-02-09"
+  s.description = "Unofficial API Wrapper for Linkbucks.com"
+  s.email = "pacopa.93@gmail.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    ".yardopts",
+    "Gemfile",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "lib/linkbucks.rb",
+    "lib/linkbucks/error.rb",
+    "lib/linkbucks/linkbucks.rb",
+    "linkbucks.gemspec",
+    "spec/linkbucks_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = "http://github.com/pacop/linkbucks"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.23"
+  s.summary = "Unofficial API Wrapper for Linkbucks.com"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<yard>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 2.0.1"])
+      s.add_development_dependency(%q<rspec>, [">= 0"])
+      s.add_development_dependency(%q<webmock>, [">= 0"])
+    else
+      s.add_dependency(%q<yard>, [">= 0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0"])
+      s.add_dependency(%q<jeweler>, ["~> 2.0.1"])
+      s.add_dependency(%q<rspec>, [">= 0"])
+      s.add_dependency(%q<webmock>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<yard>, [">= 0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0"])
+    s.add_dependency(%q<jeweler>, ["~> 2.0.1"])
+    s.add_dependency(%q<rspec>, [">= 0"])
+    s.add_dependency(%q<webmock>, [">= 0"])
+  end
+end
+

data/spec/linkbucks_spec.rb

@@ -0,0 +1,48 @@
+require 'linkbucks'
+require_relative 'spec_helper'
+
+describe Linkbucks::API do
+  
+  let!(:linkbucks) { Linkbucks::API.new VALID_USER, VALID_PASS }
+
+  describe "#initialize" do
+    it "take two params" do
+      expect { Linkbucks::API.new('') }.to raise_error(ArgumentError)
+      expect { Linkbucks::API.new('', '') }.not_to raise_error
+    end
+  end
+
+  describe "#create_link_single" do
+    context 'with valid params' do
+      it "return hash" do
+        expect(linkbucks.create_link_single(originalLink: 'http://www.google.es')).to be_kind_of(Hash)
+      end
+
+      it "response has linkId and link" do
+        expect(linkbucks.create_link_single(originalLink: 'http://www.google.es')).to include('linkId' => VALID_LINK_ID, 'link' => VALID_LINK)
+      end
+    end
+
+    context 'with invalid params' do
+
+      it "return ArgumentError if adType is invalid" do
+        expect { linkbucks.create_link_single(originalLink: 'http://www.google.es', adType: 'invalid') }.to raise_error(ArgumentError)
+      end
+
+      it "return ValidationFailed if adType is invalid" do
+        expect { linkbucks.create_link_single(originalLink: 'google.es') }.to raise_error(Linkbucks::ValidationFailed)
+      end
+
+      it "return OperationFailed if adType is invalid" do
+        expect { linkbucks.create_link_single(originalLink: 'http://www.google.es', contentType:'operationFailed') }.to raise_error(Linkbucks::OperationFailed)
+      end
+
+      it "return AuthenticationFailed if user or pass are invalid" do
+        linkbucks = Linkbucks::API.new VALID_USER, INVALID_PASS
+        expect { linkbucks.create_link_single(originalLink: 'http://www.google.es') }.to raise_error(Linkbucks::AuthenticationFailed)
+      end
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,48 @@
+require 'rspec'
+require 'webmock'
+require 'webmock/rspec'
+
+VALID_USER = 'pacop'
+VALID_PASS = '1234'
+VALID_LINK_ID = 546
+VALID_LINK = 'http://linkbucks.com/asd'
+
+INVALID_PASS = 'invalid'
+
+
+WebMock.disable_net_connect!(allow_localhost: true)
+
+RSpec.configure do |config|
+  config.before(:each) do
+
+      stub_request(:post, "https://www.linkbucks.com/api/createLink/single").
+         with(:body => "{\"user\":\"#{VALID_USER}\",\"apiPassword\":\"#{VALID_PASS}\",\"contentType\":1,\"adType\":2,\"domain\":\"linkbucks.com\",\"originalLink\":\"http://www.google.es\"}",
+              :headers => {'Accept'=>'*/*', 'User-Agent'=>'Ruby'}).
+         to_return(:status => 200, :body => "{\"linkId\": #{VALID_LINK_ID}, \"link\":\"#{VALID_LINK}\"}", :headers => {})
+      
+      stub_request(:post, "https://www.linkbucks.com/api/createLink/single").
+         with(:body => "{\"user\":\"#{VALID_USER}\",\"apiPassword\":\"#{INVALID_PASS}\",\"contentType\":1,\"adType\":2,\"domain\":\"linkbucks.com\",\"originalLink\":\"http://www.google.es\"}",
+              :headers => {'Accept'=>'*/*', 'User-Agent'=>'Ruby'}).
+         to_return(:status => 200, :body => '{"errorCode":1, "errorDescription":"Here message"}', :headers => {})
+
+      stub_request(:post, "https://www.linkbucks.com/api/createLink/single").
+         with(:body => "{\"user\":\"#{VALID_USER}\",\"apiPassword\":\"#{VALID_PASS}\",\"contentType\":1,\"adType\":\"invalid\",\"domain\":\"linkbucks.com\",\"originalLink\":\"http://www.google.es\"}",
+              :headers => {'Accept'=>'*/*', 'User-Agent'=>'Ruby'}).
+         to_return(:status => 200, :body => '{"errorCode":2, "errorDescription":"Here message"}', :headers => {})
+
+      stub_request(:post, "https://www.linkbucks.com/api/createLink/single").
+         with(:body => "{\"user\":\"pacop\",\"apiPassword\":\"1234\",\"contentType\":1,\"adType\":2,\"domain\":\"linkbucks.com\",\"originalLink\":\"google.es\"}",
+              :headers => {'Accept'=>'*/*', 'User-Agent'=>'Ruby'}).
+         to_return(:status => 200, :body =>'{"errorCode":3, "errorDescription":"Here message"}', :headers => {})
+      
+      # Here we assume that API has operation failed with this (valid)input
+      stub_request(:post, "https://www.linkbucks.com/api/createLink/single").
+         with(:body => "{\"user\":\"pacop\",\"apiPassword\":\"1234\",\"contentType\":\"operationFailed\",\"adType\":2,\"domain\":\"linkbucks.com\",\"originalLink\":\"http://www.google.es\"}",
+              :headers => {'Accept'=>'*/*', 'User-Agent'=>'Ruby'}).
+         to_return(:status => 200, :body =>'{"errorCode":4, "errorDescription":"Here message"}', :headers => {})
+
+
+  end
+end
+
+

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: linkbucks
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- pacop
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Unofficial API Wrapper for Linkbucks.com
+email: pacopa.93@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- .document
+- .rspec
+- .yardopts
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- lib/linkbucks.rb
+- lib/linkbucks/error.rb
+- lib/linkbucks/linkbucks.rb
+- linkbucks.gemspec
+- spec/linkbucks_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/pacop/linkbucks
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 924516465
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Unofficial API Wrapper for Linkbucks.com
+test_files: []