glare 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c5c89e74d7b744713d246968f87784dd5c649e43
-  data.tar.gz: 4799fd973bad72704aef4e8885e764398170ca41
+  metadata.gz: a5f191a543603fccd5d3f0b0c8de96a5f91cd657
+  data.tar.gz: 25c831074962b9946ccde5958252820987120087
 SHA512:
-  metadata.gz: 39722068385af12ec85cfd955ca49b1c99bff206b675575b52f3655e0d63247c4bf4ee4708419964dcff3bccb3a69f0cf9b964f8467935b31df57200f766f419
-  data.tar.gz: 671ad8b1f9b4cdbf9314d9da5755e03efd533cb362190da230aef4feb7535aa00df79c79f500cc8c8a2b61135d1572a7665ffc05658edeb9730f17c778e40500
+  metadata.gz: 505288e7e9ec1ea1ab83d81034962e7eeb77b29ecf29a6c681448da5a806a483287b3f4c0e7ebe4246a31b9c781493fe48957254d7f4f2001d89d527d5636519
+  data.tar.gz: 053d5b8a1b9a195eae1ccc02c99879f084e54b3351b00c50e5ab966b561a8d59c2c46ed1417120b5e41cbddee3e8d6f376bf499ed0bf5ae42e1bc64b5742d311

data/README.md

@@ -27,10 +27,52 @@ Or install it yourself as:
 
 ## Usage
 
+In order to configure credentials used to interact with Cloudflare API you will need to setup the following environment variables:
+
+- `CF_EMAIL`: Email used to create a Cloudflare account
+- `CF_AUTH_KEY`: Auth key of the given user
+
+Additionally, you can set other environment variables:
+
+- `CF_DEBUG`: Set to `1` to enable HTTP requests' debug
+
 ### Create/update DNS record
 
+```ruby
+require 'glare'
+
+Glare.register('example.domain.com', 'destination.com' ,'CNAME')
+```
+
+Where:
+  - `example.domain.com`: Name of the record to create
+  - `destination.com`: Name(s) of the values of the record
+  - `CNAME`: Type of the DNS record
+
 ### Delete DNS record
 
+```ruby
+require 'glare'
+
+Glare.deregister('example.domain.com', 'CNAME')
+```
+
+Where:
+  - `example.domain.com`: Name of the record to destroy
+  - `CNAME`: Type of the DNS record
+
+### Resolve DNS record
+
+```ruby
+require 'glare'
+
+Glare.resolve('example.domain.com', 'CNAME')
+```
+
+Where:
+  - `example.domain.com`: Name of the record to resolve
+  - `CNAME`: Type of the DNS record
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.

data/glare.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ['josacar@users.noreply.github.com', 'olopez@users.noreply.github.com']
 
   spec.summary       = 'API client for CloudFlare v4 API'
-  spec.homepage      = 'https://github.com/peertransfer/cf'
+  spec.homepage      = 'https://github.com/peertransfer/glare'
   spec.license       = 'MIT'
 
   files = Dir['lib/**/*.rb']

data/lib/glare.rb

@@ -3,9 +3,9 @@ require 'glare/version'
 require 'glare/credentials'
 require 'glare/client'
 require 'glare/domain'
-require 'glare/result'
+require 'glare/api_response'
 require 'glare/dns_record'
-require 'glare/dns_records'
+require 'glare/cf_dns_records'
 
 module Glare
   class << self

data/lib/glare/api_response.rb

@@ -0,0 +1,18 @@
+module Glare
+  class ApiResponse
+    def initialize(response)
+      @response = response
+    end
+
+    def result
+      content['result']
+    end
+
+    private
+
+    def content
+      @response.content
+    end
+  end
+  private_constant :ApiResponse
+end

data/lib/glare/cf_dns_records.rb

@@ -0,0 +1,68 @@
+module Glare
+  class CfDnsRecord
+    def initialize(id:, name:, type:, content:)
+      @id = id
+      @name = name
+      @type = type
+      @content = content
+    end
+    attr_reader :id, :name, :type, :content
+  end
+
+  class CfDnsRecords
+    class << self
+      def from_result(api_result)
+        response = ApiResponse.new(api_result)
+        result = response.result
+
+        records = result.map do |item|
+          CfDnsRecord.new(
+            id: item['id'],
+            name: item['name'],
+            type: item['type'],
+            content: item['content']
+          )
+        end
+
+        new(records)
+      end
+
+      def empty
+        new([])
+      end
+    end
+
+    def initialize(records)
+      @records = records
+    end
+
+    def to_update(desired_records)
+      @records.reject do |record|
+        desired_records.any? { |r| r.content == record.content }
+      end
+    end
+
+    def count
+      @records.count
+    end
+
+    def contents
+      @records.map(&:content)
+    end
+
+    def each
+      @records.each { |record| yield(record) }
+    end
+
+    def to_delete(target_number)
+      records_to_delete = count - target_number
+      return CfDnsRecords.empty if records_to_delete < 0
+
+      @records.last(records_to_delete)
+    end
+
+    def to_create(desired_records)
+      desired_records.drop(count)
+    end
+  end
+end

data/lib/glare/client.rb

@@ -6,7 +6,6 @@ module Glare
 
     def initialize(email, auth_key)
       @headers = {
-        'Content-Type' => 'application/json',
         'X-Auth-Email' => email,
         'X-Auth-Key' => auth_key
       }

data/lib/glare/domain.rb

@@ -1,92 +1,8 @@
+require 'glare/domain/zone'
+require 'glare/domain/record'
+
 module Glare
   class Domain
-    class Zone
-      def initialize(client, fqdn)
-        @client = client
-        @fqdn = fqdn
-      end
-
-      def records(type)
-        records = record_search(type)
-        DnsRecords.new(records)
-      end
-
-      def id
-        return @id if @id
-        zone_search = @client.get('/zones', name: registered_domain)
-        @id = Result.new(zone_search).first_result_id
-      end
-
-      private
-
-      def registered_domain
-        PublicSuffix.parse(@fqdn).domain
-      end
-
-      def record_search(type)
-        @client.get("/zones/#{id}/dns_records", name: @fqdn, type: type)
-      end
-    end
-
-    class Record
-      class << self
-        def register(client, zone, dns_records)
-          @client = client
-          existing_records = zone.records(dns_records.first.type)
-          zone_id = zone.id
-
-          update(zone_id, dns_records, existing_records)
-        end
-
-        def deregister(client, zone, dns_records)
-          @client = client
-          zone_id = zone.id
-
-          delete(zone_id, dns_records)
-        end
-
-        private
-
-        def delete(zone_id, dns_records)
-          dns_records.each do |record|
-            @client.delete("/zones/#{zone_id}/dns_records/#{record.id}")
-          end
-        end
-
-        def update(zone_id, dns_records, existing_records)
-          update_current_records(zone_id, dns_records, existing_records)
-          delete_uneeded_records(zone_id, dns_records, existing_records)
-          create_new_records(zone_id, dns_records, existing_records)
-        end
-
-        def update_current_records(zone_id, dns_records, existing_records)
-          records_to_update = existing_records.records_to_update(dns_records)
-          updates = records_to_update.zip(dns_records)
-          updates.each do |existing_record, dns_record|
-            @client.put("/zones/#{zone_id}/dns_records/#{existing_record.id}", dns_record.to_h)
-          end
-        end
-
-        def delete_uneeded_records(zone_id, dns_records, existing_records)
-          records_to_delete = existing_records.records_to_delete(dns_records.count)
-          records_to_delete.each do |record|
-            @client.delete("/zones/#{zone_id}/dns_records/#{record.id}")
-          end
-        end
-
-        def create_new_records(zone_id, dns_records, existing_records)
-          records_to_create = existing_records.records_to_create(dns_records)
-          create(zone_id, records_to_create)
-        end
-
-        def create(zone_id, dns_records)
-          dns_records.each do |dns_record|
-            @client.post("/zones/#{zone_id}/dns_records", dns_record.to_h)
-          end
-        end
-      end
-    end
-
     def initialize(client)
       @client = client
     end
@@ -102,8 +18,8 @@ module Glare
 
     def resolve(fqdn, type)
       zone = Zone.new(@client, fqdn)
-      result = zone.records(type)
-      result.contents
+      records = zone.records(type)
+      records.contents
     end
 
     def deregister(fqdn, type)

data/lib/glare/domain/cf_zones.rb

@@ -0,0 +1,37 @@
+require 'glare/domain/cf_zones'
+
+module Glare
+  class Domain
+    class CfZones
+      def self.from_result(api_response)
+        response = ApiResponse.new(api_response)
+        result = response.result
+
+        zones = result.map do |item|
+          CfZone.new(
+            id: item['id'],
+            name: item['name']
+          )
+        end
+
+        new(zones)
+      end
+
+      def initialize(zones)
+        @zones = zones
+      end
+
+      def first
+        @zones.first
+      end
+    end
+
+    class CfZone
+      def initialize(id:, name:)
+        @id = id
+        @name = name
+      end
+      attr_reader :id, :name
+    end
+  end
+end

data/lib/glare/domain/record.rb

@@ -0,0 +1,62 @@
+module Glare
+  class Domain
+    class Record
+      class << self
+        def register(client, zone, dns_records)
+          @client = client
+          existing_records = zone.records(dns_records.first.type)
+          zone_id = zone.id
+
+          update(zone_id, dns_records, existing_records)
+        end
+
+        def deregister(client, zone, dns_records)
+          @client = client
+          zone_id = zone.id
+
+          delete(zone_id, dns_records)
+        end
+
+        private
+
+        def delete(zone_id, dns_records)
+          dns_records.each do |record|
+            @client.delete("/zones/#{zone_id}/dns_records/#{record.id}")
+          end
+        end
+
+        def update(zone_id, dns_records, existing_records)
+          update_current_records(zone_id, dns_records, existing_records)
+          delete_uneeded_records(zone_id, dns_records, existing_records)
+          create_new_records(zone_id, dns_records, existing_records)
+        end
+
+        def update_current_records(zone_id, dns_records, existing_records)
+          records_to_update = existing_records.to_update(dns_records)
+          updates = records_to_update.zip(dns_records)
+          updates.each do |existing_record, dns_record|
+            @client.put("/zones/#{zone_id}/dns_records/#{existing_record.id}", dns_record.to_h)
+          end
+        end
+
+        def delete_uneeded_records(zone_id, dns_records, existing_records)
+          records_to_delete = existing_records.to_delete(dns_records.count)
+          records_to_delete.each do |record|
+            @client.delete("/zones/#{zone_id}/dns_records/#{record.id}")
+          end
+        end
+
+        def create_new_records(zone_id, dns_records, existing_records)
+          records_to_create = existing_records.to_create(dns_records)
+          create(zone_id, records_to_create)
+        end
+
+        def create(zone_id, dns_records)
+          dns_records.each do |dns_record|
+            @client.post("/zones/#{zone_id}/dns_records", dns_record.to_h)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/glare/domain/zone.rb

@@ -0,0 +1,33 @@
+require 'glare/domain/cf_zones'
+
+module Glare
+  class Domain
+    class Zone
+      def initialize(client, fqdn)
+        @client = client
+        @fqdn = fqdn
+      end
+
+      def records(type)
+        api_result = record_search(type)
+        CfDnsRecords.from_result(api_result)
+      end
+
+      def id
+        return @id if @id
+        zone_search = @client.get('/zones', name: registered_domain)
+        @id = CfZones.from_result(zone_search).first.id
+      end
+
+      private
+
+      def registered_domain
+        PublicSuffix.parse(@fqdn).domain
+      end
+
+      def record_search(type)
+        @client.get("/zones/#{id}/dns_records", name: @fqdn, type: type)
+      end
+    end
+  end
+end

data/lib/glare/version.rb

@@ -1,3 +1,3 @@
 module Glare
-  VERSION = '0.1.1'.freeze
+  VERSION = '0.1.2'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: glare
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Jose Luis Salas
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-20 00:00:00.000000000 Z
+date: 2016-07-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -96,12 +96,15 @@ files:
 - README.md
 - glare.gemspec
 - lib/glare.rb
+- lib/glare/api_response.rb
+- lib/glare/cf_dns_records.rb
 - lib/glare/client.rb
 - lib/glare/credentials.rb
 - lib/glare/dns_record.rb
-- lib/glare/dns_records.rb
 - lib/glare/domain.rb
-- lib/glare/result.rb
+- lib/glare/domain/cf_zones.rb
+- lib/glare/domain/record.rb
+- lib/glare/domain/zone.rb
 - lib/glare/version.rb
 - spec/delete_domain_spec.rb
 - spec/fixtures/empty_result.json
@@ -110,7 +113,7 @@ files:
 - spec/resolve_domain_spec.rb
 - spec/spec_helper.rb
 - spec/units/glare_spec.rb
-homepage: https://github.com/peertransfer/cf
+homepage: https://github.com/peertransfer/glare
 licenses:
 - MIT
 metadata: {}
@@ -135,10 +138,10 @@ signing_key:
 specification_version: 4
 summary: API client for CloudFlare v4 API
 test_files:
+- spec/units/glare_spec.rb
 - spec/delete_domain_spec.rb
 - spec/resolve_domain_spec.rb
 - spec/spec_helper.rb
-- spec/units/glare_spec.rb
+- spec/fixtures/wadus_records.json
 - spec/fixtures/empty_result.json
 - spec/fixtures/list_zone.json
-- spec/fixtures/wadus_records.json

data/lib/glare/dns_records.rb

@@ -1,56 +0,0 @@
-module Glare
-  class CfDnsRecord
-    def initialize(id:, name:, type:, content:)
-      @id = id
-      @name = name
-      @type = type
-      @content = content
-    end
-    attr_reader :id, :name, :type, :content
-  end
-
-  class DnsRecords < Result
-    def initialize(result)
-      super(result)
-      @records = records
-    end
-
-    def records_to_update(desired_records)
-      @records.reject do |record|
-        desired_records.any? { |r| r.content == record.content }
-      end
-    end
-
-    def count
-      @records.count
-    end
-
-    def each
-      @records.each { |record| yield(record) }
-    end
-
-    def records_to_delete(targer_number)
-      records_to_delete = count - targer_number
-      return [] if records_to_delete < 0
-
-      @records.pop(records_to_delete)
-    end
-
-    def records_to_create(desired_records)
-      desired_records.drop(count)
-    end
-
-    private
-
-    def records
-      result['result'].map do |item|
-        CfDnsRecord.new(
-          id: item['id'],
-          name: item['name'],
-          type: item['type'],
-          content: item['content']
-        )
-      end
-    end
-  end
-end

data/lib/glare/result.rb

@@ -1,26 +0,0 @@
-module Glare
-  class Result
-    def initialize(result)
-      @result = result
-    end
-
-    def ocurrences
-      result['result_info']['count'].to_i
-    end
-
-    def first_result_id
-      result['result'].first['id']
-    end
-
-    def contents
-      Array(result['result']).map { |item| item['content'] }
-    end
-
-    private
-
-    def result
-      @result.content
-    end
-  end
-  private_constant :Result
-end